juce/source/extras/Introjucer/Source/Project/jucer_ProjectExport_Android.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-10 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #ifndef __JUCER_PROJECTEXPORT_ANDROID_JUCEHEADER__
  27 #define __JUCER_PROJECTEXPORT_ANDROID_JUCEHEADER__
  28
  29 #include "jucer_ProjectExporter.h"
  30
  31
  32 //==============================================================================
  33 class AndroidProjectExporter  : public ProjectExporter
  34 {
  35 public:
  36     //==============================================================================
  37     static const char* getNameAndroid()         { return "Android Project"; }
  38     static const char* getValueTreeTypeName()   { return "ANDROID"; }
  39
  40     static AndroidProjectExporter* createForSettings (Project& project, const ValueTree& settings)
  41     {
  42         if (settings.hasType (getValueTreeTypeName()))
  43             return new AndroidProjectExporter (project, settings);
  44
  45         return 0;
  46     }
  47
  48     //==============================================================================
  49     AndroidProjectExporter (Project& project_, const ValueTree& settings_)
  50         : ProjectExporter (project_, settings_)
  51     {
  52         name = getNameAndroid();
  53
  54         if (getTargetLocation().toString().isEmpty())
  55             getTargetLocation() = getDefaultBuildsRootFolder() + "Android";
  56
  57         if (getSDKPath().toString().isEmpty())
  58             getSDKPath() = "${user.home}/SDKs/android-sdk-mac_x86";
  59
  60         if (getNDKPath().toString().isEmpty())
  61             getNDKPath() = "${user.home}/SDKs/android-ndk-r5";
  62
  63         if (getInternetNeeded().toString().isEmpty())
  64             getInternetNeeded() = true;
  65     }
  66
  67     //==============================================================================
  68     bool isDefaultFormatForCurrentOS()
  69     {
  70       #if JUCE_ANDROID
  71         return true;
  72       #else
  73         return false;
  74       #endif
  75     }
  76
  77     bool isPossibleForCurrentProject()          { return project.isGUIApplication(); }
  78     bool usesMMFiles() const                    { return false; }
  79
  80     void launchProject()
  81     {
  82     }
  83
  84     void createPropertyEditors (Array <PropertyComponent*>& props)
  85     {
  86         ProjectExporter::createPropertyEditors (props);
  87
  88         props.add (new TextPropertyComponent (getSDKPath(), "Android SDK Path", 1024, false));
  89         props.getLast()->setTooltip ("The path to the Android SDK folder on the target build machine");
  90
  91         props.add (new TextPropertyComponent (getNDKPath(), "Android NDK Path", 1024, false));
  92         props.getLast()->setTooltip ("The path to the Android NDK folder on the target build machine");
  93
  94         props.add (new BooleanPropertyComponent (getInternetNeeded(), "Internet Access", "Specify internet access permission in the manifest"));
  95         props.getLast()->setTooltip ("If enabled, this will set the android.permission.INTERNET flag in the manifest.");
  96     }
  97
  98     Value getSDKPath() const                    { return getSetting (Ids::androidSDKPath); }
  99     Value getNDKPath() const                    { return getSetting (Ids::androidNDKPath); }
 100     Value getInternetNeeded() const             { return getSetting (Ids::androidInternetNeeded); }
 101
 102     //==============================================================================
 103     void create()
 104     {
 105         const File target (getTargetFolder());
 106         const File jniFolder (target.getChildFile ("jni"));
 107
 108         createDirectoryOrThrow (target.getChildFile ("src/com"));
 109         createDirectoryOrThrow (jniFolder);
 110         createDirectoryOrThrow (target.getChildFile ("res/drawable-hdpi"));
 111         createDirectoryOrThrow (target.getChildFile ("res/drawable-mdpi"));
 112         createDirectoryOrThrow (target.getChildFile ("res/drawable-ldpi"));
 113         createDirectoryOrThrow (target.getChildFile ("res/values"));
 114         createDirectoryOrThrow (target.getChildFile ("libs"));
 115         createDirectoryOrThrow (target.getChildFile ("bin"));
 116
 117         {
 118             ScopedPointer<XmlElement> manifest (createManifestXML());
 119             writeXmlOrThrow (*manifest, target.getChildFile ("AndroidManifest.xml"), "utf-8", 100);
 120         }
 121
 122         writeApplicationMk (jniFolder.getChildFile ("Application.mk"));
 123         writeAndroidMk (jniFolder.getChildFile ("Android.mk"));
 124
 125         {
 126             ScopedPointer<XmlElement> antBuildXml (createAntBuildXML());
 127             writeXmlOrThrow (*antBuildXml, target.getChildFile ("build.xml"), "UTF-8", 100);
 128         }
 129
 130         writeBuildPropertiesFile (target.getChildFile ("build.properties"));
 131         writeDefaultPropertiesFile (target.getChildFile ("default.properties"));
 132         writeLocalPropertiesFile (target.getChildFile ("local.properties"));
 133
 134         writeIcon (target.getChildFile ("res/drawable-hdpi/icon.png"), 72);
 135         writeIcon (target.getChildFile ("res/drawable-mdpi/icon.png"), 48);
 136         writeIcon (target.getChildFile ("res/drawable-ldpi/icon.png"), 36);
 137
 138         writeStringsFile (target.getChildFile ("res/values/strings.xml"));
 139     }
 140
 141 private:
 142     //==============================================================================
 143     XmlElement* createManifestXML()
 144     {
 145         XmlElement* manifest = new XmlElement ("manifest");
 146
 147         manifest->setAttribute ("xmlns:android", "http://schemas.android.com/apk/res/android");
 148         manifest->setAttribute ("android:versionCode", "1");
 149         manifest->setAttribute ("android:versionName", "1.0");
 150         manifest->setAttribute ("package", "com.juce");
 151
 152         XmlElement* screens = manifest->createNewChildElement ("supports-screens");
 153         screens->setAttribute ("android:smallScreens", "true");
 154         screens->setAttribute ("android:normalScreens", "true");
 155         screens->setAttribute ("android:largeScreens", "true");
 156         screens->setAttribute ("android:xlargeScreens", "true");
 157         screens->setAttribute ("android:anyDensity", "true");
 158
 159         if (getInternetNeeded().getValue())
 160         {
 161             XmlElement* permission = manifest->createNewChildElement ("uses-permission");
 162             permission->setAttribute ("android:name", "android.permission.INTERNET");
 163         }
 164
 165         XmlElement* app = manifest->createNewChildElement ("application");
 166         app->setAttribute ("android:label", "@string/app_name");
 167         app->setAttribute ("android:icon", "@drawable/icon");
 168
 169         XmlElement* act = app->createNewChildElement ("activity");
 170         act->setAttribute ("android:name", "JuceAppActivity");
 171         act->setAttribute ("android:label", "@string/app_name");
 172
 173         XmlElement* intent = act->createNewChildElement ("intent-filter");
 174         intent->createNewChildElement ("action")->setAttribute ("android:name", "android.intent.action.MAIN");
 175         intent->createNewChildElement ("category")->setAttribute ("android:name", "android.intent.category.LAUNCHER");
 176
 177         return manifest;
 178     }
 179
 180     //==============================================================================
 181     void findAllFilesToCompile (const Project::Item& projectItem, Array<RelativePath>& results)
 182     {
 183         if (projectItem.isGroup())
 184         {
 185             for (int i = 0; i < projectItem.getNumChildren(); ++i)
 186                 findAllFilesToCompile (projectItem.getChild(i), results);
 187         }
 188         else
 189         {
 190             if (projectItem.shouldBeCompiled())
 191                 results.add (RelativePath (projectItem.getFile(), getTargetFolder(), RelativePath::buildTargetFolder));
 192         }
 193     }
 194
 195     void writeApplicationMk (const File& file)
 196     {
 197         MemoryOutputStream mo;
 198
 199         mo << "# Automatically generated makefile, created by the Jucer" << newLine
 200            << "# Don't edit this file! Your changes will be overwritten when you re-save the Jucer project!" << newLine
 201            << newLine
 202            << "APP_STL := gnustl_static" << newLine
 203            << "APP_CPPFLAGS += -fsigned-char -fexceptions -frtti" << newLine;
 204
 205         overwriteFileIfDifferentOrThrow (file, mo);
 206     }
 207
 208     void writeAndroidMk (const File& file)
 209     {
 210         Array<RelativePath> files;
 211         findAllFilesToCompile (project.getMainGroup(), files);
 212
 213         for (int i = 0; i < juceWrapperFiles.size(); ++i)
 214             if (shouldFileBeCompiledByDefault (juceWrapperFiles.getReference(i)))
 215                 files.add (juceWrapperFiles.getReference(i));
 216
 217         MemoryOutputStream mo;
 218         writeAndroidMk (mo, files);
 219
 220         overwriteFileIfDifferentOrThrow (file, mo);
 221     }
 222
 223     void writeAndroidMk (OutputStream& out, const Array<RelativePath>& files)
 224     {
 225         out << "# Automatically generated makefile, created by the Jucer" << newLine
 226             << "# Don't edit this file! Your changes will be overwritten when you re-save the Jucer project!" << newLine
 227             << newLine
 228             << "LOCAL_PATH := $(call my-dir)" << newLine
 229             << newLine
 230             << "include $(CLEAR_VARS)" << newLine
 231             << newLine
 232             << "LOCAL_CPP_EXTENSION := cpp" << newLine
 233             << "LOCAL_MODULE := juce_jni" << newLine
 234             << "LOCAL_SRC_FILES := \\" << newLine;
 235
 236         for (int i = 0; i < files.size(); ++i)
 237             out << "  ../" << escapeSpaces (files.getReference(i).toUnixStyle()) << "\\" << newLine;
 238
 239         out << newLine
 240             << "ifeq ($(CONFIG),Debug)" << newLine
 241             << "  LOCAL_CPPFLAGS += " << createCPPFlags (true) << newLine
 242             << "else" << newLine
 243             << "  LOCAL_CPPFLAGS += " << createCPPFlags (false) << newLine
 244             << "endif" << newLine
 245             << newLine
 246             << "include $(BUILD_SHARED_LIBRARY)" << newLine;
 247     }
 248
 249     const String createCPPFlags (bool forDebug)
 250     {
 251         String flags ("-fsigned-char -fexceptions -frtti");
 252
 253         if (forDebug)
 254             flags << " -g";
 255
 256         StringPairArray defines;
 257         defines.set ("JUCE_ANDROID", "1");
 258
 259         if (forDebug)
 260         {
 261             defines.set ("DEBUG", "1");
 262             defines.set ("_DEBUG", "1");
 263         }
 264         else
 265         {
 266             defines.set ("NDEBUG", "1");
 267         }
 268
 269         for (int i = 0; i < project.getNumConfigurations(); ++i)
 270         {
 271             Project::BuildConfiguration config (project.getConfiguration(i));
 272
 273             if (config.isDebug() == forDebug)
 274             {
 275                 flags << " -O" << config.getGCCOptimisationFlag();
 276
 277                 defines = mergePreprocessorDefs (defines, getAllPreprocessorDefs (config));
 278                 break;
 279             }
 280         }
 281
 282         return flags + createGCCPreprocessorFlags (defines);
 283     }
 284
 285     //==============================================================================
 286     XmlElement* createAntBuildXML()
 287     {
 288         XmlElement* proj = new XmlElement ("project");
 289         proj->setAttribute ("name", project.getProjectName().toString());
 290         proj->setAttribute ("default", "debug");
 291
 292         proj->createNewChildElement ("property")->setAttribute ("file", "local.properties");
 293         proj->createNewChildElement ("property")->setAttribute ("file", "build.properties");
 294         proj->createNewChildElement ("property")->setAttribute ("file", "default.properties");
 295
 296         XmlElement* path = proj->createNewChildElement ("path");
 297         path->setAttribute ("id", "android.antlibs");
 298         path->createNewChildElement ("pathelement")->setAttribute ("path", "${sdk.dir}/tools/lib/anttasks.jar");
 299         path->createNewChildElement ("pathelement")->setAttribute ("path", "${sdk.dir}/tools/lib/sdklib.jar");
 300         path->createNewChildElement ("pathelement")->setAttribute ("path", "${sdk.dir}/tools/lib/androidprefs.jar");
 301
 302         XmlElement* taskdef = proj->createNewChildElement ("taskdef");
 303         taskdef->setAttribute ("name", "setup");
 304         taskdef->setAttribute ("classname", "com.android.ant.SetupTask");
 305         taskdef->setAttribute ("classpathref", "android.antlibs");
 306
 307         addNDKBuildStep (proj, "clean", "clean");
 308
 309         //addLinkStep (proj, "${basedir}/" + rebaseFromProjectFolderToBuildTarget (RelativePath()).toUnixStyle() + "/", "jni/app");
 310         addLinkStep (proj, "${basedir}/" + getJucePathFromTargetFolder().toUnixStyle() + "/src/native/android/java/", "src/com/juce");
 311
 312         addNDKBuildStep (proj, "debug", "CONFIG=Debug");
 313         addNDKBuildStep (proj, "release", "CONFIG=Release");
 314
 315         proj->createNewChildElement ("setup");
 316
 317         return proj;
 318     }
 319
 320     static void addNDKBuildStep (XmlElement* project, const String& type, const String& arg)
 321     {
 322         XmlElement* target = project->createNewChildElement ("target");
 323         target->setAttribute ("name", type);
 324
 325         XmlElement* executable = target->createNewChildElement ("exec");
 326         executable->setAttribute ("executable", "${ndk.dir}/ndk-build");
 327         executable->setAttribute ("dir", "${basedir}");
 328         executable->setAttribute ("failonerror", "true");
 329
 330         executable->createNewChildElement ("arg")->setAttribute ("value", "--jobs=2");
 331         executable->createNewChildElement ("arg")->setAttribute ("value", arg);
 332     }
 333
 334     static void addLinkStep (XmlElement* project, const String& from, const String& to)
 335     {
 336         XmlElement* executable = project->createNewChildElement ("exec");
 337         executable->setAttribute ("executable", "ln");
 338         executable->setAttribute ("dir", "${basedir}");
 339         executable->setAttribute ("failonerror", "false");
 340
 341         executable->createNewChildElement ("arg")->setAttribute ("value", "-s");
 342         executable->createNewChildElement ("arg")->setAttribute ("value", from);
 343         executable->createNewChildElement ("arg")->setAttribute ("value", to);
 344     }
 345
 346     void writeBuildPropertiesFile (const File& file)
 347     {
 348         MemoryOutputStream mo;
 349         mo << "# This file is used to override default values used by the Ant build system." << newLine;
 350         overwriteFileIfDifferentOrThrow (file, mo);
 351     }
 352
 353     void writeDefaultPropertiesFile (const File& file)
 354     {
 355         MemoryOutputStream mo;
 356         mo << "# This file is used to override default values used by the Ant build system." << newLine
 357            << "# It is automatically generated - DO NOT EDIT IT or your changes will be lost!." << newLine
 358            << newLine
 359            << "target=android-9"
 360            << newLine;
 361
 362         overwriteFileIfDifferentOrThrow (file, mo);
 363     }
 364
 365     void writeLocalPropertiesFile (const File& file)
 366     {
 367         MemoryOutputStream mo;
 368         mo << "# This file is used to override default values used by the Ant build system." << newLine
 369            << "# It is automatically generated by the Jucer - DO NOT EDIT IT or your changes will be lost!." << newLine
 370            << newLine
 371            << "sdk.dir=" << escapeSpaces (replacePreprocessorDefs (getAllPreprocessorDefs(), getSDKPath().toString())) << newLine
 372            << "ndk.dir=" << escapeSpaces (replacePreprocessorDefs (getAllPreprocessorDefs(), getNDKPath().toString())) << newLine
 373            << newLine;
 374
 375         overwriteFileIfDifferentOrThrow (file, mo);
 376     }
 377
 378     void writeIcon (const File& file, int size)
 379     {
 380         Image im (project.getBestIconForSize (size, false));
 381
 382         if (im.isValid())
 383         {
 384             PNGImageFormat png;
 385             MemoryOutputStream mo;
 386
 387             if (! png.writeImageToStream (im, mo))
 388                 throw SaveError ("Can't generate Android icon file");
 389
 390             overwriteFileIfDifferentOrThrow (file, mo);
 391         }
 392     }
 393
 394     void writeStringsFile (const File& file)
 395     {
 396         XmlElement strings ("resources");
 397         XmlElement* name = strings.createNewChildElement ("string");
 398         name->setAttribute ("name", "app_name");
 399         name->addTextElement (project.getProjectName().toString());
 400
 401         writeXmlOrThrow (strings, file, "utf-8", 100);
 402     }
 403
 404     //==============================================================================
 405     JUCE_DECLARE_NON_COPYABLE (AndroidProjectExporter);
 406 };
 407
 408
 409 #endif   // __JUCER_PROJECTEXPORT_ANDROID_JUCEHEADER__