rel to cgeo#16250: enhance handling of asynchronous events, make dial…

…ogs visually more like activities
eddiemuc · Oct 20, 2024 · 50cd6f5 · 50cd6f5
1 parent 82f53c8
commit 50cd6f5
Show file tree

Hide file tree

Showing 12 changed files with 151 additions and 130 deletions.
diff --git a/main/src/main/java/cgeo/geocaching/unifiedmap/UnifiedMapActivity.java b/main/src/main/java/cgeo/geocaching/unifiedmap/UnifiedMapActivity.java
@@ -72,9 +72,8 @@
 import cgeo.geocaching.utils.Log;
 import cgeo.geocaching.utils.MapMarkerUtils;
 import cgeo.geocaching.utils.functions.Func1;
-import cgeo.geocaching.wherigo.WherigoDialogManager;
 import cgeo.geocaching.wherigo.WherigoGame;
-import cgeo.geocaching.wherigo.WherigoThingDialogProvider;
+import cgeo.geocaching.wherigo.WherigoUtils;
 import static cgeo.geocaching.filters.gui.GeocacheFilterActivity.EXTRA_FILTER_CONTEXT;
 import static cgeo.geocaching.settings.Settings.MAPROTATION_AUTO_LOWPOWER;
 import static cgeo.geocaching.settings.Settings.MAPROTATION_AUTO_PRECISE;
@@ -1119,7 +1118,7 @@ private void handleTap(final MapSelectableItem item, final Geopoint touchedPoint
                 MapMarkerUtils.addHighlighting(routeItem.getWaypoint(), getResources(), nonClickableItemsLayer);
             }
         } else if (item.getData() instanceof Zone) {
-            WherigoDialogManager.get().display(new WherigoThingDialogProvider(item.getData()));
+            WherigoUtils.displayThing(this, item.getData(), false);
         } else if (item.getData() instanceof String) {
             GeoItemTestLayer.handleTapTest(clickableItemsLayer, this, touchedPoint, item.getData().toString(), isLongTap);
         }

diff --git a/main/src/main/java/cgeo/geocaching/wherigo/WherigoActivity.java b/main/src/main/java/cgeo/geocaching/wherigo/WherigoActivity.java
@@ -102,17 +102,7 @@ public final void onCreate(final Bundle savedInstanceState) {
         setThemeAndContentView(binding);
 
         binding.wherigoThingTypeList.setModel(wherigoThingTypeModel);
-        wherigoThingTypeModel.addSingleSelectListener(type -> {
-            final List<EventTable> things = type.getThingsForUserDisplay();
-            if (things.isEmpty()) {
-                return;
-            }
-            if (things.size() == 1) {
-                WherigoDialogManager.displayDirect(this, new WherigoThingDialogProvider(things.get(0)));
-            } else {
-                WherigoDialogManager.displayDirect(this, new WherigoThingListDialogProvider(type));
-            }
-        });
+        wherigoThingTypeModel.addSingleSelectListener(type -> WherigoUtils.chooseAndDisplayThing(this, type));
 
         refreshGui();
 
@@ -121,9 +111,7 @@ public final void onCreate(final Bundle savedInstanceState) {
         binding.saveGame.setOnClickListener(v -> saveGame());
         binding.stopGame.setOnClickListener(v -> stopGame());
         binding.download.setOnClickListener(v -> manualCartridgeDownload());
-        binding.reportProblem.setOnClickListener(v -> {
-            WherigoDialogManager.get().display(new WherigoErrorDialogProvider());
-        });
+        binding.reportProblem.setOnClickListener(v -> WherigoDialogManager.get().display(new WherigoErrorDialogProvider()));
 
         binding.map.setOnClickListener(v -> showOnMap());
 

diff --git a/main/src/main/java/cgeo/geocaching/wherigo/WherigoCartridgeDialogProvider.java b/main/src/main/java/cgeo/geocaching/wherigo/WherigoCartridgeDialogProvider.java
@@ -51,10 +51,8 @@ public WherigoCartridgeDialogProvider(final WherigoCartridgeInfo cartridgeInfo)
 
     @Override
     public Dialog createDialog(final Activity activity, final Consumer<Boolean> resultSetter) {
-        final AlertDialog.Builder builder = new AlertDialog.Builder(activity, R.style.cgeo_fullScreen);
+        final AlertDialog dialog = WherigoUtils.createFullscreenDialog(activity, cartridgeFile.name);
         binding = WherigoCartridgeDetailsBinding.inflate(LayoutInflater.from(activity));
-        final AlertDialog dialog = builder.create();
-        dialog.setTitle(cartridgeFile.name);
         dialog.setView(binding.getRoot());
 
         final List<WherigoSavegameInfo> saveGames = cartridgeInfo.getLoadableSavegames();

diff --git a/main/src/main/java/cgeo/geocaching/wherigo/WherigoGame.java b/main/src/main/java/cgeo/geocaching/wherigo/WherigoGame.java
@@ -314,31 +314,44 @@ public void pushInput(final EventTable input) {
         WherigoDialogManager.get().display(new WherigoInputDialogProvider(input));
     }
 
+    /**
+     * From OpenWIG doku:
+     * Shows a specified screen
+     * <p>
+     * The screen specified by screenId should be made visible.
+     * If a dialog or an input is open, it must be closed before
+     * showing the screen.
+     * @param screenId the screen to be shown
+     * @param details if screenId is DETAILSCREEN, details of this object will be displayed
+     */
     @Override
-    public void showScreen(final int screenId, final EventTable eventTable) {
-        Log.iForce(LOG_PRAEFIX + "showScreen:" + screenId + ":" + eventTable);
+    public void showScreen(final int screenId, final EventTable details) {
+        Log.iForce(LOG_PRAEFIX + "showScreen:" + screenId + ":" + details);
 
         switch (screenId) {
             case MAINSCREEN:
+            case INVENTORYSCREEN:
+            case ITEMSCREEN:
+            case LOCATIONSCREEN:
+            case TASKSCREEN:
+                WherigoDialogManager.get().clear();
                 final Activity currentActivity = CgeoApplication.getInstance().getCurrentForegroundActivity();
                 if (currentActivity instanceof WherigoActivity) {
                     return;
                 }
-                if (currentActivity != null && !openOnlyInWherigo()) {
-                    WherigoActivity.start(currentActivity, false);
+                //don't open the screens here, just issue a toast advising user to check
+                final WherigoThingType type = WherigoThingType.getByWherigoScreenId(screenId);
+                if (type == null) {
+                    ActivityMixin.showApplicationToast(LocalizationUtils.getString(R.string.wherigo_toast_check_game));
+                } else {
+                    ActivityMixin.showApplicationToast(LocalizationUtils.getString(R.string.wherigo_toast_check_things, type.toUserDisplayableString()));
                 }
                 break;
-            case INVENTORYSCREEN:
-            case ITEMSCREEN:
-            case LOCATIONSCREEN:
-            case TASKSCREEN:
-                WherigoDialogManager.get().display(new WherigoThingListDialogProvider(WherigoThingType.getByWherigoScreenId(screenId)));
-                break;
             case DETAILSCREEN:
-                WherigoDialogManager.get().display(new WherigoThingDialogProvider(eventTable));
+                WherigoUtils.displayThing(null, details, true);
                 break;
             default:
-                Log.w(LOG_PRAEFIX + "showDialog called with unknown screenId: " + screenId + " [" + eventTable + "]");
+                Log.w(LOG_PRAEFIX + "showDialog called with unknown screenId: " + screenId + " [" + details + "]");
                 // do nothing
                 break;
         }
@@ -367,6 +380,12 @@ public void unblock() {
         WherigoSaveFileHandler.get().loadSaveFinished(); // Ends a running SAVE
     }
 
+    /**
+     * From OpenWIG Doku:
+     * Issues a command
+     * <p>
+     * This function should issue a command (SaveClose, DriveTo, StopSound, Alert).
+     */
     @Override
     public void command(final String cmd) {
         Log.iForce(LOG_PRAEFIX + "command:" + cmd);

diff --git a/main/src/main/java/cgeo/geocaching/wherigo/WherigoInputDialogProvider.java b/main/src/main/java/cgeo/geocaching/wherigo/WherigoInputDialogProvider.java
@@ -7,6 +7,7 @@
 import cgeo.geocaching.ui.TextParam;
 import cgeo.geocaching.utils.CommonUtils;
 import cgeo.geocaching.utils.EditUtils;
+import cgeo.geocaching.utils.LocalizationUtils;
 
 import android.app.Activity;
 import android.app.AlertDialog;
@@ -66,9 +67,9 @@ public Dialog createDialog(final Activity activity, final Consumer<Boolean> resu
 
         final WherigoGame game = WherigoGame.get();
 
-        final AlertDialog.Builder builder = new AlertDialog.Builder(activity, R.style.cgeo_fullScreenDialog);
+        final AlertDialog dialog = WherigoUtils.createFullscreenDialog(activity, LocalizationUtils.getString(R.string.wherigo_player));
+
         binding = WherigoThingDetailsBinding.inflate(LayoutInflater.from(activity));
-        final AlertDialog dialog = builder.create();
         dialog.setView(binding.getRoot());
         binding.description.setText(game.toDisplayText((String) input.table.rawget("Text")));
 

diff --git a/main/src/main/java/cgeo/geocaching/wherigo/WherigoPushDialogProvider.java b/main/src/main/java/cgeo/geocaching/wherigo/WherigoPushDialogProvider.java
@@ -72,9 +72,8 @@ public class WherigoPushDialogProvider implements IWherigoDialogProvider {
 
     @Override
     public Dialog createDialog(final Activity activity, final Consumer<Boolean> resultSetter) {
-        final AlertDialog.Builder builder = new AlertDialog.Builder(activity, R.style.cgeo_fullScreenDialog);
+        final AlertDialog dialog = WherigoUtils.createFullscreenDialog(activity, LocalizationUtils.getString(R.string.wherigo_player));
         binding = WherigoThingDetailsBinding.inflate(LayoutInflater.from(activity));
-        final AlertDialog dialog = builder.create();
         dialog.setView(binding.getRoot());
 
         refreshGui();

diff --git a/main/src/main/java/cgeo/geocaching/wherigo/WherigoThingDialogProvider.java b/main/src/main/java/cgeo/geocaching/wherigo/WherigoThingDialogProvider.java
@@ -6,6 +6,7 @@
 import cgeo.geocaching.maps.DefaultMap;
 import cgeo.geocaching.ui.ImageParam;
 import cgeo.geocaching.ui.TextParam;
+import cgeo.geocaching.utils.Log;
 
 import android.app.Activity;
 import android.app.AlertDialog;
@@ -20,6 +21,7 @@
 import java.util.function.Consumer;
 
 import cz.matejcik.openwig.Action;
+import cz.matejcik.openwig.Engine;
 import cz.matejcik.openwig.EventTable;
 import cz.matejcik.openwig.Media;
 import cz.matejcik.openwig.Thing;
@@ -56,16 +58,20 @@ public WherigoThingDialogProvider(final EventTable et) {
 
     @Override
     public Dialog createDialog(final Activity activity, final Consumer<Boolean> resultSetter) {
-        final AlertDialog.Builder builder = new AlertDialog.Builder(activity, R.style.cgeo_fullScreen);
+        final AlertDialog dialog = WherigoUtils.createFullscreenDialog(activity, eventTable.name);
         binding = WherigoThingDetailsBinding.inflate(LayoutInflater.from(activity));
-        final AlertDialog dialog = builder.create();
-        dialog.setTitle(eventTable.name);
         dialog.setView(binding.getRoot());
+
         weakActivity = new WeakReference<>(activity);
         weakDialog = new WeakReference<>(dialog);
 
         refreshGui();
 
+        if (eventTable.hasEvent("OnClick")) {
+            Log.iForce("Wherigo: item has 'OnClick': " + eventTable);
+            Engine.callEvent(eventTable, "OnClick", null);
+        }
+
         return dialog;
     }
 

diff --git a/main/src/main/java/cgeo/geocaching/wherigo/WherigoThingListDialogProvider.java b/main/src/main/java/cgeo/geocaching/wherigo/WherigoThingListDialogProvider.java