Ticket #9286: ScummVM_Sparkle.patch

base/main.cpp

@@ -52 +52 @@
 #include "gui/GuiManager.h"
 #include "gui/message.h"
 #include "gui/error.h"
+#if defined(USE_SPARKLE)
+        #include "gui/sparkle_osx.h"
+#endif
 
 #include "sound/audiocd.h"
 #include "sound/mididrv.h"
@@ -377 +380 @@
         // Now as the event manager is created, setup the keymapper
         setupKeymapper(system);
 
+        // Setup the "Check for Updates..." menu on Mac-OSX when built with Sparkle support
+        #if defined(USE_SPARKLE)
+                GUI::SparkleMenu sparkleMenu;
+                sparkleMenu.addUpdateMenuItem();
+        #endif  
+
         // Unless a game was specified, show the launcher dialog
         if (0 == ConfMan.getActiveDomain())
                 launcherDialog();

scummvm-1.2.

@@ -123 +123 @@
 _alsa=auto
 _seq_midi=auto
 _zlib=auto
+_sparkle=auto
 _mpeg2=no
 _fluidsynth=auto
 _16bit=auto
@@ -730 +731 @@
                            installed (optional)
   --disable-fluidsynth     disable fluidsynth MIDI driver [autodetect]
 
+  --with-sparkle-prefix=DIR   Prefix where sparkle is installed (MacOSX only - optional)
+  --disable-sparkle        disable sparkle automatic update support [MacOSX only - autodetect]
+
   --with-sdl-prefix=DIR    Prefix where the sdl-config script is
                            installed (optional)
 
@@ -773 +777 @@
         --disable-mad)            _mad=no         ;;
         --enable-zlib)            _zlib=yes       ;;
         --disable-zlib)           _zlib=no        ;;
+        --enable-sparkle)         _sparkle=yes    ;;
+        --disable-sparkle)        _sparkle=no     ;;
         --enable-nasm)            _nasm=yes       ;;
         --disable-nasm)           _nasm=no        ;;
         --enable-mpeg2)           _mpeg2=yes      ;;
@@ -839 +845 @@
                 ZLIB_CFLAGS="-I$arg/include"
                 ZLIB_LIBS="-L$arg/lib"
                 ;;
+        --with-sparkle-prefix=*)
+                arg=`echo $ac_option | cut -d '=' -f 2`
+                SPARKLE_CFLAGS="-F$arg"
+                SPARKLE_LIBS="-framework Sparkle -F$arg"
+                ;;
         --with-readline-prefix=*)
                 arg=`echo $ac_option | cut -d '=' -f 2`
                 READLINE_CFLAGS="-I$arg/include"
@@ -2362 +2374 @@
 echo "$_zlib"
 
 #
+# Check for Sparkle
+#
+echocheck "Sparkle"
+if test "$_sparkle" = auto ; then
+        _sparkle=no
+        cat > $TMPC << EOF
+#include <Cocoa/Cocoa.h>
+#include <Sparkle/Sparkle.h>
+int main(void) { SUUpdater *updater = [SUUpdater sharedUpdater]; return 0; }
+EOF
+        cc_check $SPARKLE_CFLAGS $SPARKLE_LIBS -ObjC++ -lobjc && _sparkle=yes
+fi
+if test "$_sparkle" = yes ; then
+        LIBS="$LIBS $SPARKLE_LIBS"
+        INCLUDES="$INCLUDES $SPARKLE_CFLAGS"
+fi
+define_in_config_if_yes "$_sparkle" 'USE_SPARKLE'
+echo "$_sparkle"
+
+#
 # Check for LibMPEG2
 #
 echocheck "libmpeg2 >= 0.3.2"

dists/macosx/Info.plist

@@ -28 +28 @@
         <string>NSApplication</string>
         <key>NSHumanReadableCopyright</key>
         <string>Copyright 2001-2010 The ScummVM team</string>
+        <key>SUFeedURL</key>
+        <string>http://scummvm.org/scummvm_appcast.xml</string>
+        <key>SUPublicDSAKeyFile</key>
+        <string>dsa_pub.pem</string>
 </dict>
 </plist>

dists/macosx/Info.plist.in

@@ -28 +28 @@
         <string>NSApplication</string>
         <key>NSHumanReadableCopyright</key>
         <string>Copyright 2001-2010 The ScummVM team</string>
+        <key>SUFeedURL</key>
+        <string>http://scummvm.org/scummvm_appcast.xml</string>
+        <key>SUPublicDSAKeyFile</key>
+        <string>dsa_pub.pem</string>
 </dict>
 </plist>

dists/macosx/scummvm_appcast.xml

@@ +1 @@
+<?xml version="1.0" encoding="utf-8"?>
+<rss version="2.0" xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle"  xmlns:dc="http://purl.org/dc/elements/1.1/">
+   <channel>
+      <title>ScummVM Changelog</title>
+      <link>http://scummvm.org/scummvm_appcast.xml</link>
+      <description>Most recent changes with links to updates.</description>
+      <language>en</language>
+         <item>
+            <title>Version 1.2.1 (3 bugs fixed; 2 new features)</title>
+                                                <sparkle:releaseNotesLink>
+                                                        http://sourceforge.net/projects/scummvm/files/scummvm/1.2.1/ReleaseNotes/view
+                                                </sparkle:releaseNotesLink>
+            <pubDate>Sun, 19 Dec 2010 12:20:11 +0000</pubDate>
+            <enclosure url="http://scummvm.org/ScummVM 1.2.1-Test.zip" sparkle:version="1.2.1" length="1472893" type="application/octet-stream" sparkle:dsaSignature="234818feCa1JyW30nbkBwainOzrN6EQuAh" />
+         </item>
+         <item>
+            <title>Version 1.2.0</title>
+                                                <sparkle:releaseNotesLink>
+                                                        http://sourceforge.net/projects/scummvm/files/scummvm/1.2.0/ReleaseNotes/view
+                                                </sparkle:releaseNotesLink>
+            <pubDate>Fri, 15 Oct 2010 12:20:11 +0000</pubDate>
+            <enclosure url="http://scummvm.org/ScummVM 1.2.0-Test.zip" sparkle:version="1.2.0" length="1472893" type="application/octet-stream" sparkle:dsaSignature="234818feCa1JyW30nbkBwainOzrN6EQuAh" />
+         </item>
+   </channel>
+</rss>
+ No newline at end of file

gui/module.mk

@@ -36 +36 @@
         browser.o
 endif
 
+ifdef USE_SPARKLE
+MODULE_OBJS += \
+        sparkle_osx.o
+endif
+
+
 # Include common rules
 include $(srcdir)/rules.mk

gui/sparkle_osx.h

@@ +1 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program 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.
+
+ * This program 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 this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ *
+ */
+
+#ifndef SPARKLE_OSX_H
+#define SPARKLE_OSX_H
+
+namespace GUI {
+
+class SparkleMenu {
+public:
+        SparkleMenu(void);
+        virtual ~SparkleMenu();
+        virtual void addUpdateMenuItem();
+};
+
+} // End of namespace GUI
+
+#endif

gui/sparkle_osx.mm

@@ +1 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program 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.
+
+ * This program 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 this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ *
+ */
+
+#include "gui/sparkle_osx.h"
+
+#include <Cocoa/Cocoa.h>
+#include <Sparkle/Sparkle.h>
+
+namespace GUI {
+
+SparkleMenu::SparkleMenu(void) {}
+SparkleMenu::~SparkleMenu() {}
+
+void SparkleMenu::addUpdateMenuItem() {
+    NSMenuItem *menuItem = [[NSApp mainMenu] itemAtIndex:0];
+    NSMenu *applicationMenu = [menuItem submenu];
+
+        /* Add "Check for Updates..." menu item */
+        SUUpdater *updater = [SUUpdater sharedUpdater];
+        NSMenuItem *updateMenuItem = [applicationMenu insertItemWithTitle:@"Check for Updates..." action:@selector(checkForUpdates:) keyEquivalent:@"" atIndex:1];
+        [updateMenuItem setTarget:updater];
+        [updater checkForUpdatesInBackground];
+}
+
+} // End of namespace GUI

scummvm-1.2.

@@ -41 +41 @@
         mkdir -p $(bundle_name)/Contents/Resources
         echo "APPL????" > $(bundle_name)/Contents/PkgInfo
         cp $(srcdir)/dists/macosx/Info.plist $(bundle_name)/Contents/
+ifdef USE_SPARKLE
+        mkdir -p $(bundle_name)/Contents/Frameworks
+        cp $(srcdir)/dists/macosx/dsa_pub.pem $(bundle_name)/Contents/Resources/
+        cp -R $(STATICLIBPATH)/Sparkle.framework $(bundle_name)/Contents/Frameworks/
+endif
         cp $(srcdir)/icons/scummvm.icns $(bundle_name)/Contents/Resources/
         cp $(DIST_FILES_DOCS) $(bundle_name)/
         cp $(DIST_FILES_THEMES) $(bundle_name)/Contents/Resources/
@@ -101 +106 @@
 OSX_ZLIB ?= -lz
 endif
 
+ifdef USE_SPARKLE
+OSX_STATIC_LIBS += -framework Sparkle -F$(STATICLIBPATH)
+endif
+
 ifdef USE_TERMCONV
 OSX_ICONV ?= -liconv
 endif