DISTRHO
/
JUCE
mirror of https://github.com/DISTRHO/JUCE
1
0
Fork 0
Code Releases 1 Activity
The JUCE cross-platform C++ framework, with DISTRHO/KXStudio specific changes
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
5723 Commits
9 Branches
435MB
Tree: a99d78318b
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'a99d78318b'
${ noResults }
JUCE/extras/Introjucer/Source/Project Saving/jucer_ProjectExport_Android.h

867 lines
39KB
Raw Blame History 

  1. /*

  2.   ==============================================================================

  3. 

  4.    This file is part of the JUCE library.

  5.    Copyright (c) 2015 - ROLI Ltd.

  6. 

  7.    Permission is granted to use this software under the terms of either:

  8.    a) the GPL v2 (or any later version)

  9.    b) the Affero GPL v3

  10. 

  11.    Details of these licenses can be found at: www.gnu.org/licenses

  12. 

  13.    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY

  14.    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR

  15.    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

  16. 

  17.    ------------------------------------------------------------------------------

  18. 

  19.    To release a closed-source product which uses JUCE, commercial licenses are

  20.    available: visit www.juce.com for more information.

  21. 

  22.   ==============================================================================

  23. */

  24. 

  25. class AndroidProjectExporterBase  : public ProjectExporter

  26. {

  27. public:

  28.     AndroidProjectExporterBase (Project& p, const ValueTree& t)

  29.         : ProjectExporter (p, t)

  30.     {

  31.         if (getVersionCodeString().isEmpty())

  32.             getVersionCodeValue() = 1;

  33. 

  34.         if (getActivityClassPath().isEmpty())

  35.             getActivityClassPathValue() = createDefaultClassName();

  36. 

  37.         if (getMinimumSDKVersionString().isEmpty())

  38.             getMinimumSDKVersionValue() = 10;

  39. 

  40.         if (getInternetNeededValue().toString().isEmpty())

  41.             getInternetNeededValue() = true;

  42. 

  43.         if (getBluetoothPermissionsValue().toString().isEmpty())

  44.             getBluetoothPermissionsValue() = true;

  45. 

  46.         if (getKeyStoreValue().getValue().isVoid())         getKeyStoreValue()      = "${user.home}/.android/debug.keystore";

  47.         if (getKeyStorePassValue().getValue().isVoid())     getKeyStorePassValue()  = "android";

  48.         if (getKeyAliasValue().getValue().isVoid())         getKeyAliasValue()      = "androiddebugkey";

  49.         if (getKeyAliasPassValue().getValue().isVoid())     getKeyAliasPassValue()  = "android";

  50.         if (getCPP11EnabledValue().getValue().isVoid())     getCPP11EnabledValue()  = true;

  51. 

  52.         initialiseDependencyPathValues();

  53.     }

  54. 

  55.     bool canLaunchProject() override                     { return false; }

  56.     bool launchProject() override                        { return false; }

  57.     bool isAndroid() const override                      { return true; }

  58.     bool usesMMFiles() const override                    { return false; }

  59.     bool canCopeWithDuplicateFiles() override            { return false; }

  60. 

  61.     void create (const OwnedArray<LibraryModule>& modules) const override

  62.     {

  63.         const String package (getActivityClassPackage());

  64.         const String path (package.replaceCharacter ('.', File::separator));

  65.         const File target (getTargetFolder().getChildFile ("src").getChildFile (path));

  66. 

  67.         copyActivityJavaFiles (modules, target, package);

  68.     }

  69. 

  70.     void createExporterProperties (PropertyListBuilder& props) override

  71.     {

  72.         props.add (new TextPropertyComponent (getActivityClassPathValue(), "Android Activity class name", 256, false),

  73.                    "The full java class name to use for the app's Activity class.");

  74. 

  75.         props.add (new TextPropertyComponent (getActivitySubClassPathValue(), "Android Activity sub-class name", 256, false),

  76.                    "If not empty, specifies the Android Activity class name stored in the app's manifest. "

  77.                    "Use this if you would like to use your own Android Activity sub-class.");

  78. 

  79.         props.add (new TextPropertyComponent (getVersionCodeValue(), "Android Version Code", 32, false),

  80.                    "An integer value that represents the version of the application code, relative to other versions.");

  81. 

  82.         props.add (new DependencyPathPropertyComponent (getSDKPathValue(), "Android SDK Path"),

  83.                    "The path to the Android SDK folder on the target build machine");

  84. 

  85.         props.add (new DependencyPathPropertyComponent (getNDKPathValue(), "Android NDK Path"),

  86.                    "The path to the Android NDK folder on the target build machine");

  87. 

  88.         props.add (new TextPropertyComponent (getMinimumSDKVersionValue(), "Minimum SDK version", 32, false),

  89.                    "The number of the minimum version of the Android SDK that the app requires");

  90. 

  91.         props.add (new TextPropertyComponent (getNDKToolchainVersionValue(), "NDK Toolchain version", 32, false),

  92.                    "The variable NDK_TOOLCHAIN_VERSION in Application.mk - leave blank for a default value");

  93. 

  94.         props.add (new BooleanPropertyComponent (getCPP11EnabledValue(), "Enable C++11 features", "Enable the -std=c++11 flag"),

  95.                    "If enabled, this will set the -std=c++11 flag for the build.");

  96. 

  97.         props.add (new BooleanPropertyComponent (getInternetNeededValue(), "Internet Access", "Specify internet access permission in the manifest"),

  98.                    "If enabled, this will set the android.permission.INTERNET flag in the manifest.");

  99. 

  100.         props.add (new BooleanPropertyComponent (getAudioRecordNeededValue(), "Audio Input Required", "Specify audio record permission in the manifest"),

  101.                    "If enabled, this will set the android.permission.RECORD_AUDIO flag in the manifest.");

  102. 

  103.         props.add (new BooleanPropertyComponent (getBluetoothPermissionsValue(), "Bluetooth permissions Required", "Specify bluetooth permission (required for Bluetooth MIDI)"),

  104.                    "If enabled, this will set the android.permission.BLUETOOTH and  android.permission.BLUETOOTH_ADMIN flag in the manifest. This is required for Bluetooth MIDI on Android.");

  105. 

  106.         props.add (new TextPropertyComponent (getOtherPermissionsValue(), "Custom permissions", 2048, false),

  107.                    "A space-separated list of other permission flags that should be added to the manifest.");

  108. 

  109.         props.add (new TextPropertyComponent (getStaticLibrariesValue(), "Import static library modules", 8192, true),

  110.                    "Comma or whitespace delimited list of static libraries (.a) defined in NDK_MODULE_PATH.");

  111. 

  112.         props.add (new TextPropertyComponent (getSharedLibrariesValue(), "Import shared library modules", 8192, true),

  113.                    "Comma or whitespace delimited list of shared libraries (.so) defined in NDK_MODULE_PATH.");

  114. 

  115.         props.add (new TextPropertyComponent (getThemeValue(), "Android Theme", 256, false),

  116.                    "E.g. @android:style/Theme.NoTitleBar or leave blank for default");

  117. 

  118.         props.add (new TextPropertyComponent (getKeyStoreValue(), "Key Signing: key.store", 2048, false),

  119.                    "The key.store value, used when signing the package.");

  120.         props.add (new TextPropertyComponent (getKeyStorePassValue(), "Key Signing: key.store.password", 2048, false),

  121.                    "The key.store password, used when signing the package.");

  122.         props.add (new TextPropertyComponent (getKeyAliasValue(), "Key Signing: key.alias", 2048, false),

  123.                    "The key.alias value, used when signing the package.");

  124.         props.add (new TextPropertyComponent (getKeyAliasPassValue(), "Key Signing: key.alias.password", 2048, false),

  125.                    "The key.alias password, used when signing the package.");

  126.     }

  127. 

  128.     Value  getActivityClassPathValue()              { return getSetting (Ids::androidActivityClass); }

  129.     String getActivityClassPath() const             { return settings [Ids::androidActivityClass]; }

  130.     Value  getActivitySubClassPathValue()           { return getSetting (Ids::androidActivitySubClassName); }

  131.     String getActivitySubClassPath() const          { return settings [Ids::androidActivitySubClassName]; }

  132.     Value  getVersionCodeValue()                    { return getSetting (Ids::androidVersionCode); }

  133.     String getVersionCodeString() const             { return settings [Ids::androidVersionCode]; }

  134.     Value  getSDKPathValue()                        { return sdkPath; }

  135.     String getSDKPathString() const                 { return sdkPath.toString(); }

  136.     Value  getNDKPathValue()                        { return ndkPath; }

  137.     String getNDKPathString() const                 { return ndkPath.toString(); }

  138.     Value  getNDKToolchainVersionValue()            { return getSetting (Ids::toolset); }

  139.     String getNDKToolchainVersionString() const     { return settings [Ids::toolset]; }

  140. 

  141.     Value  getKeyStoreValue()                       { return getSetting (Ids::androidKeyStore); }

  142.     String getKeyStoreString() const                { return settings [Ids::androidKeyStore]; }

  143.     Value  getKeyStorePassValue()                   { return getSetting (Ids::androidKeyStorePass); }

  144.     String getKeyStorePassString() const            { return settings [Ids::androidKeyStorePass]; }

  145.     Value  getKeyAliasValue()                       { return getSetting (Ids::androidKeyAlias); }

  146.     String getKeyAliasString() const                { return settings [Ids::androidKeyAlias]; }

  147.     Value  getKeyAliasPassValue()                   { return getSetting (Ids::androidKeyAliasPass); }

  148.     String getKeyAliasPassString() const            { return settings [Ids::androidKeyAliasPass]; }

  149. 

  150.     Value  getInternetNeededValue()                 { return getSetting (Ids::androidInternetNeeded); }

  151.     bool   getInternetNeeded() const                { return settings [Ids::androidInternetNeeded]; }

  152.     Value  getAudioRecordNeededValue()              { return getSetting (Ids::androidMicNeeded); }

  153.     bool   getAudioRecordNeeded() const             { return settings [Ids::androidMicNeeded]; }

  154.     Value  getBluetoothPermissionsValue()           { return getSetting(Ids::androidBluetoothNeeded); }

  155.     bool   getBluetoothPermissions() const          { return settings[Ids::androidBluetoothNeeded]; }

  156.     Value  getMinimumSDKVersionValue()              { return getSetting (Ids::androidMinimumSDK); }

  157.     String getMinimumSDKVersionString() const       { return settings [Ids::androidMinimumSDK]; }

  158.     Value  getOtherPermissionsValue()               { return getSetting (Ids::androidOtherPermissions); }

  159.     String getOtherPermissions() const              { return settings [Ids::androidOtherPermissions]; }

  160. 

  161.     Value  getThemeValue()                          { return getSetting (Ids::androidTheme); }

  162.     String getThemeString() const                   { return settings [Ids::androidTheme]; }

  163. 

  164.     Value  getStaticLibrariesValue()                { return getSetting (Ids::androidStaticLibraries); }

  165.     String getStaticLibrariesString() const         { return settings [Ids::androidStaticLibraries]; }

  166. 

  167.     Value  getSharedLibrariesValue()                { return getSetting (Ids::androidSharedLibraries); }

  168.     String getSharedLibrariesString() const         { return settings [Ids::androidSharedLibraries]; }

  169. 

  170.     Value getCPP11EnabledValue()                    { return getSetting (Ids::androidCpp11); }

  171.     bool isCPP11Enabled() const                     { return settings [Ids::androidCpp11]; }

  172. 

  173.     //==============================================================================

  174.     String createDefaultClassName() const

  175.     {

  176.         String s (project.getBundleIdentifier().toString().toLowerCase());

  177. 

  178.         if (s.length() > 5

  179.             && s.containsChar ('.')

  180.             && s.containsOnly ("abcdefghijklmnopqrstuvwxyz_.")

  181.             && ! s.startsWithChar ('.'))

  182.         {

  183.             if (! s.endsWithChar ('.'))

  184.                 s << ".";

  185.         }

  186.         else

  187.         {

  188.             s = "com.yourcompany.";

  189.         }

  190. 

  191.         return s + CodeHelpers::makeValidIdentifier (project.getProjectFilenameRoot(), false, true, false);

  192.     }

  193. 

  194.     void initialiseDependencyPathValues()

  195.     {

  196.         sdkPath.referTo (Value (new DependencyPathValueSource (getSetting (Ids::androidSDKPath),

  197.                                                                Ids::androidSDKPath, TargetOS::getThisOS())));

  198. 

  199.         ndkPath.referTo (Value (new DependencyPathValueSource (getSetting (Ids::androidNDKPath),

  200.                                                                Ids::androidNDKPath, TargetOS::getThisOS())));

  201.     }

  202. 

  203.     void copyActivityJavaFiles (const OwnedArray<LibraryModule>& modules, const File& targetFolder, const String& package) const

  204.     {

  205.         const String className (getActivityName());

  206. 

  207.         if (className.isEmpty())

  208.             throw SaveError ("Invalid Android Activity class name: " + getActivityClassPath());

  209. 

  210.         createDirectoryOrThrow (targetFolder);

  211. 

  212.         LibraryModule* const coreModule = getCoreModule (modules);

  213. 

  214.         if (coreModule != nullptr)

  215.         {

  216.             File javaDestFile (targetFolder.getChildFile (className + ".java"));

  217. 

  218.             File javaSourceFolder (coreModule->getFolder().getChildFile ("native")

  219.                                                           .getChildFile ("java"));

  220. 

  221.             String juceMidiCode, juceMidiImports;

  222. 

  223.             juceMidiImports << newLine;

  224. 

  225.             if (getMinimumSDKVersionString().getIntValue() >= 23)

  226.             {

  227.                 File javaAndroidMidi (javaSourceFolder.getChildFile ("AndroidMidi.java"));

  228. 

  229.                 juceMidiImports << "import android.media.midi.*;" << newLine

  230.                                 << "import android.bluetooth.*;" << newLine

  231.                                 << "import android.bluetooth.le.*;" << newLine;

  232. 

  233.                 juceMidiCode = javaAndroidMidi.loadFileAsString().replace ("JuceAppActivity", className);

  234.             }

  235.             else

  236.             {

  237.                 juceMidiCode = javaSourceFolder.getChildFile ("AndroidMidiFallback.java")

  238.                                    .loadFileAsString()

  239.                                    .replace ("JuceAppActivity", className);

  240.             }

  241. 

  242.             File javaSourceFile (javaSourceFolder.getChildFile ("JuceAppActivity.java"));

  243.             StringArray javaSourceLines (StringArray::fromLines (javaSourceFile.loadFileAsString()));

  244. 

  245.             {

  246.                 MemoryOutputStream newFile;

  247. 

  248.                 for (int i = 0; i < javaSourceLines.size(); ++i)

  249.                 {

  250.                     const String& line = javaSourceLines[i];

  251. 

  252.                     if (line.contains ("$$JuceAndroidMidiImports$$"))

  253.                         newFile << juceMidiImports;

  254.                     else if (line.contains ("$$JuceAndroidMidiCode$$"))

  255.                         newFile << juceMidiCode;

  256.                     else

  257.                         newFile << line.replace ("JuceAppActivity", className)

  258.                                        .replace ("package com.juce;", "package " + package + ";") << newLine;

  259.                 }

  260. 

  261.                 javaSourceLines = StringArray::fromLines (newFile.toString());

  262.             }

  263. 

  264.             while (javaSourceLines.size() > 2

  265.                     && javaSourceLines[javaSourceLines.size() - 1].trim().isEmpty()

  266.                     && javaSourceLines[javaSourceLines.size() - 2].trim().isEmpty())

  267.                 javaSourceLines.remove (javaSourceLines.size() - 1);

  268. 

  269.             overwriteFileIfDifferentOrThrow (javaDestFile, javaSourceLines.joinIntoString (newLine));

  270.         }

  271.     }

  272. 

  273.     String getAppPlatform() const

  274.     {

  275.         int ndkVersion = getMinimumSDKVersionString().getIntValue();

  276.         if (ndkVersion == 9)

  277.             ndkVersion = 10; // (doesn't seem to be a version '9')

  278. 

  279.         return "android-" + String (ndkVersion);

  280.     }

  281. 

  282.     String getActivityName() const

  283.     {

  284.         return getActivityClassPath().fromLastOccurrenceOf (".", false, false);

  285.     }

  286. 

  287.     String getActivitySubClassName() const

  288.     {

  289.         String activityPath = getActivitySubClassPath();

  290. 

  291.         return (activityPath.isEmpty()) ? getActivityName() : activityPath.fromLastOccurrenceOf (".", false, false);

  292.     }

  293. 

  294.     String getActivityClassPackage() const

  295.     {

  296.         return getActivityClassPath().upToLastOccurrenceOf (".", false, false);

  297.     }

  298. 

  299.     String getJNIActivityClassName() const

  300.     {

  301.         return getActivityClassPath().replaceCharacter ('.', '/');

  302.     }

  303. 

  304.     static LibraryModule* getCoreModule (const OwnedArray<LibraryModule>& modules)

  305.     {

  306.         for (int i = modules.size(); --i >= 0;)

  307.             if (modules.getUnchecked(i)->getID() == "juce_core")

  308.                 return modules.getUnchecked(i);

  309. 

  310.         return nullptr;

  311.     }

  312. 

  313.     String getCppFlags() const

  314.     {

  315.         String flags ("-fsigned-char -fexceptions -frtti");

  316. 

  317.         if (! getNDKToolchainVersionString().startsWithIgnoreCase ("clang"))

  318.             flags << " -Wno-psabi";

  319. 

  320.         return flags;

  321.     }

  322. 

  323.     StringArray getPermissionsRequired() const

  324.     {

  325.         StringArray s;

  326.         s.addTokens (getOtherPermissions(), ", ", "");

  327. 

  328.         if (getInternetNeeded())

  329.             s.add ("android.permission.INTERNET");

  330. 

  331.         if (getAudioRecordNeeded())

  332.             s.add ("android.permission.RECORD_AUDIO");

  333. 

  334.         if (getBluetoothPermissions())

  335.         {

  336.             s.add ("android.permission.BLUETOOTH");

  337.             s.add ("android.permission.BLUETOOTH_ADMIN");

  338.             s.add ("android.permission.ACCESS_COARSE_LOCATION");

  339.         }

  340. 

  341.         return getCleanedStringArray (s);

  342.     }

  343. 

  344.     template <typename PredicateT>

  345.     void findAllProjectItemsWithPredicate (const Project::Item& projectItem, Array<RelativePath>& results, const PredicateT& predicate) const

  346.     {

  347.         if (projectItem.isGroup())

  348.         {

  349.             for (int i = 0; i < projectItem.getNumChildren(); ++i)

  350.                 findAllProjectItemsWithPredicate (projectItem.getChild(i), results, predicate);

  351.         }

  352.         else

  353.         {

  354.             if (predicate (projectItem))

  355.                 results.add (RelativePath (projectItem.getFile(), getTargetFolder(), RelativePath::buildTargetFolder));

  356.         }

  357.     }

  358. 

  359.     void writeIcon (const File& file, const Image& im) const

  360.     {

  361.         if (im.isValid())

  362.         {

  363.             createDirectoryOrThrow (file.getParentDirectory());

  364. 

  365.             PNGImageFormat png;

  366.             MemoryOutputStream mo;

  367. 

  368.             if (! png.writeImageToStream (im, mo))

  369.                 throw SaveError ("Can't generate Android icon file");

  370. 

  371.             overwriteFileIfDifferentOrThrow (file, mo);

  372.         }

  373.     }

  374. 

  375.     void writeIcons (const File& folder) const

  376.     {

  377.         ScopedPointer<Drawable> bigIcon (getBigIcon());

  378.         ScopedPointer<Drawable> smallIcon (getSmallIcon());

  379. 

  380.         if (bigIcon != nullptr && smallIcon != nullptr)

  381.         {

  382.             const int step = jmax (bigIcon->getWidth(), bigIcon->getHeight()) / 8;

  383.             writeIcon (folder.getChildFile ("drawable-xhdpi/icon.png"), getBestIconForSize (step * 8, false));

  384.             writeIcon (folder.getChildFile ("drawable-hdpi/icon.png"),  getBestIconForSize (step * 6, false));

  385.             writeIcon (folder.getChildFile ("drawable-mdpi/icon.png"),  getBestIconForSize (step * 4, false));

  386.             writeIcon (folder.getChildFile ("drawable-ldpi/icon.png"),  getBestIconForSize (step * 3, false));

  387.         }

  388.         else if (Drawable* icon = bigIcon != nullptr ? bigIcon : smallIcon)

  389.         {

  390.             writeIcon (folder.getChildFile ("drawable-mdpi/icon.png"), rescaleImageForIcon (*icon, icon->getWidth()));

  391.         }

  392.     }

  393. 

  394.     template <typename BuildConfigType>

  395.     String getABIs (bool forDebug) const

  396.     {

  397.         for (ConstConfigIterator config (*this); config.next();)

  398.         {

  399.             const BuildConfigType& androidConfig = dynamic_cast<const BuildConfigType&> (*config);

  400. 

  401.             if (config->isDebug() == forDebug)

  402.                 return androidConfig.getArchitectures();

  403.         }

  404. 

  405.         return String();

  406.     }

  407. 

  408.     //==============================================================================

  409.     XmlElement* createManifestXML() const

  410.     {

  411.         XmlElement* manifest = new XmlElement ("manifest");

  412. 

  413.         manifest->setAttribute ("xmlns:android", "http://schemas.android.com/apk/res/android");

  414.         manifest->setAttribute ("android:versionCode", getVersionCodeString());

  415.         manifest->setAttribute ("android:versionName",  project.getVersionString());

  416.         manifest->setAttribute ("package", getActivityClassPackage());

  417. 

  418.         XmlElement* screens = manifest->createNewChildElement ("supports-screens");

  419.         screens->setAttribute ("android:smallScreens", "true");

  420.         screens->setAttribute ("android:normalScreens", "true");

  421.         screens->setAttribute ("android:largeScreens", "true");

  422.         //screens->setAttribute ("android:xlargeScreens", "true");

  423.         screens->setAttribute ("android:anyDensity", "true");

  424. 

  425.         XmlElement* sdk = manifest->createNewChildElement ("uses-sdk");

  426.         sdk->setAttribute ("android:minSdkVersion", getMinimumSDKVersionString());

  427.         sdk->setAttribute ("android:targetSdkVersion", "11");

  428. 

  429.         {

  430.             const StringArray permissions (getPermissionsRequired());

  431. 

  432.             for (int i = permissions.size(); --i >= 0;)

  433.                 manifest->createNewChildElement ("uses-permission")->setAttribute ("android:name", permissions[i]);

  434.         }

  435. 

  436.         if (project.getModules().isModuleEnabled ("juce_opengl"))

  437.         {

  438.             XmlElement* feature = manifest->createNewChildElement ("uses-feature");

  439.             feature->setAttribute ("android:glEsVersion", "0x00020000");

  440.             feature->setAttribute ("android:required", "true");

  441.         }

  442. 

  443.         XmlElement* app = manifest->createNewChildElement ("application");

  444.         app->setAttribute ("android:label", "@string/app_name");

  445. 

  446.         String androidThemeString (getThemeString());

  447.         if (androidThemeString.isNotEmpty())

  448.             app->setAttribute ("android:theme", androidThemeString);

  449. 

  450.         {

  451.             ScopedPointer<Drawable> bigIcon (getBigIcon()), smallIcon (getSmallIcon());

  452. 

  453.             if (bigIcon != nullptr || smallIcon != nullptr)

  454.                 app->setAttribute ("android:icon", "@drawable/icon");

  455.         }

  456. 

  457.         if (getMinimumSDKVersionString().getIntValue() >= 11)

  458.             app->setAttribute ("android:hardwareAccelerated", "false"); // (using the 2D acceleration slows down openGL)

  459. 

  460.         XmlElement* act = app->createNewChildElement ("activity");

  461.         act->setAttribute ("android:name", getActivitySubClassName());

  462.         act->setAttribute ("android:label", "@string/app_name");

  463.         act->setAttribute ("android:configChanges", "keyboardHidden|orientation");

  464. 

  465.         XmlElement* intent = act->createNewChildElement ("intent-filter");

  466.         intent->createNewChildElement ("action")->setAttribute ("android:name", "android.intent.action.MAIN");

  467.         intent->createNewChildElement ("category")->setAttribute ("android:name", "android.intent.category.LAUNCHER");

  468. 

  469.         return manifest;

  470.     }

  471. 

  472.     //==============================================================================

  473.     Value sdkPath, ndkPath;

  474. 

  475.     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (AndroidProjectExporterBase)

  476. };

  477. 

  478. 

  479. //==============================================================================

  480. //==============================================================================

  481. class AndroidAntProjectExporter  : public AndroidProjectExporterBase

  482. {

  483. public:

  484.     //==============================================================================

  485.     static const char* getName()                { return "Android Ant Project"; }

  486.     static const char* getValueTreeTypeName()   { return "ANDROID"; }

  487. 

  488.     static AndroidAntProjectExporter* createForSettings (Project& project, const ValueTree& settings)

  489.     {

  490.         if (settings.hasType (getValueTreeTypeName()))

  491.             return new AndroidAntProjectExporter (project, settings);

  492. 

  493.         return nullptr;

  494.     }

  495. 

  496.     //==============================================================================

  497.     AndroidAntProjectExporter (Project& p, const ValueTree& t)

  498.         : AndroidProjectExporterBase (p, t)

  499.     {

  500.         name = getName();

  501. 

  502.         if (getTargetLocationString().isEmpty())

  503.             getTargetLocationValue() = getDefaultBuildsRootFolder() + "Android";

  504.     }

  505. 

  506.     //==============================================================================

  507.     void createExporterProperties (PropertyListBuilder& props) override

  508.     {

  509.         AndroidProjectExporterBase::createExporterProperties (props);

  510.     }

  511. 

  512.     void create (const OwnedArray<LibraryModule>& modules) const override

  513.     {

  514.         AndroidProjectExporterBase::create (modules);

  515. 

  516.         const File target (getTargetFolder());

  517.         const File jniFolder (target.getChildFile ("jni"));

  518. 

  519.         createDirectoryOrThrow (jniFolder);

  520.         createDirectoryOrThrow (target.getChildFile ("res").getChildFile ("values"));

  521.         createDirectoryOrThrow (target.getChildFile ("libs"));

  522.         createDirectoryOrThrow (target.getChildFile ("bin"));

  523. 

  524.         {

  525.             ScopedPointer<XmlElement> manifest (createManifestXML());

  526.             writeXmlOrThrow (*manifest, target.getChildFile ("AndroidManifest.xml"), "utf-8", 100, true);

  527.         }

  528. 

  529.         writeApplicationMk (jniFolder.getChildFile ("Application.mk"));

  530.         writeAndroidMk (jniFolder.getChildFile ("Android.mk"));

  531. 

  532.         {

  533.             ScopedPointer<XmlElement> antBuildXml (createAntBuildXML());

  534.             writeXmlOrThrow (*antBuildXml, target.getChildFile ("build.xml"), "UTF-8", 100);

  535.         }

  536. 

  537.         writeProjectPropertiesFile (target.getChildFile ("project.properties"));

  538.         writeLocalPropertiesFile (target.getChildFile ("local.properties"));

  539.         writeStringsFile (target.getChildFile ("res/values/strings.xml"));

  540.         writeIcons (target.getChildFile ("res"));

  541.     }

  542. 

  543.     //==============================================================================

  544.     class AndroidBuildConfiguration  : public BuildConfiguration

  545.     {

  546.     public:

  547.         AndroidBuildConfiguration (Project& p, const ValueTree& settings, const ProjectExporter& e)

  548.             : BuildConfiguration (p, settings, e)

  549.         {

  550.             if (getArchitectures().isEmpty())

  551.             {

  552.                 if (isDebug())

  553.                     getArchitecturesValue() = "armeabi x86";

  554.                 else

  555.                     getArchitecturesValue() = "armeabi armeabi-v7a x86";

  556.             }

  557.         }

  558. 

  559.         Value getArchitecturesValue()           { return getValue (Ids::androidArchitectures); }

  560.         String getArchitectures() const         { return config [Ids::androidArchitectures]; }

  561. 

  562.         var getDefaultOptimisationLevel() const override    { return var ((int) (isDebug() ? gccO0 : gccO3)); }

  563. 

  564.         void createConfigProperties (PropertyListBuilder& props) override

  565.         {

  566.             addGCCOptimisationProperty (props);

  567. 

  568.             props.add (new TextPropertyComponent (getArchitecturesValue(), "Architectures", 256, false),

  569.                        "A list of the ARM architectures to build (for a fat binary).");

  570.         }

  571.     };

  572. 

  573.     BuildConfiguration::Ptr createBuildConfig (const ValueTree& v) const override

  574.     {

  575.         return new AndroidBuildConfiguration (project, v, *this);

  576.     }

  577. 

  578. private:

  579.     //==============================================================================

  580.     String getToolchainVersion() const

  581.     {

  582.         String v (getNDKToolchainVersionString());

  583.         return v.isNotEmpty() ? v : "4.8";

  584.     }

  585. 

  586.     void writeApplicationMk (const File& file) const

  587.     {

  588.         MemoryOutputStream mo;

  589. 

  590.         mo << "# Automatically generated makefile, created by the Introjucer" << newLine

  591.            << "# Don't edit this file! Your changes will be overwritten when you re-save the Introjucer project!" << newLine

  592.            << newLine

  593.            << "APP_STL := gnustl_static" << newLine

  594.            << "APP_CPPFLAGS += " << getCppFlags() << newLine

  595.            << "APP_PLATFORM := " << getAppPlatform() << newLine

  596.            << "NDK_TOOLCHAIN_VERSION := " << getToolchainVersion() << newLine

  597.            << newLine

  598.            << "ifeq ($(NDK_DEBUG),1)" << newLine

  599.            << "    APP_ABI := " << getABIs<AndroidBuildConfiguration> (true) << newLine

  600.            << "else" << newLine

  601.            << "    APP_ABI := " << getABIs<AndroidBuildConfiguration> (false) << newLine

  602.            << "endif" << newLine;

  603. 

  604.         overwriteFileIfDifferentOrThrow (file, mo);

  605.     }

  606. 

  607.     struct ShouldFileBeCompiledPredicate

  608.     {

  609.         bool operator() (const Project::Item& projectItem) const  { return projectItem.shouldBeCompiled(); }

  610.     };

  611. 

  612.     void writeAndroidMk (const File& file) const

  613.     {

  614.         Array<RelativePath> files;

  615. 

  616.         for (int i = 0; i < getAllGroups().size(); ++i)

  617.             findAllProjectItemsWithPredicate (getAllGroups().getReference(i), files, ShouldFileBeCompiledPredicate());

  618. 

  619.         MemoryOutputStream mo;

  620.         writeAndroidMk (mo, files);

  621. 

  622.         overwriteFileIfDifferentOrThrow (file, mo);

  623.     }

  624. 

  625.     void writeAndroidMkVariableList (OutputStream& out, const String& variableName, const String& settingsValue) const

  626.     {

  627.         const StringArray separatedItems (getCommaOrWhitespaceSeparatedItems (settingsValue));

  628. 

  629.         if (separatedItems.size() > 0)

  630.             out << newLine << variableName << " := " << separatedItems.joinIntoString (" ") << newLine;

  631.     }

  632. 

  633.     void writeAndroidMk (OutputStream& out, const Array<RelativePath>& files) const

  634.     {

  635.         out << "# Automatically generated makefile, created by the Introjucer" << newLine

  636.             << "# Don't edit this file! Your changes will be overwritten when you re-save the Introjucer project!" << newLine

  637.             << newLine

  638.             << "LOCAL_PATH := $(call my-dir)" << newLine

  639.             << newLine

  640.             << "include $(CLEAR_VARS)" << newLine

  641.             << newLine

  642.             << "ifeq ($(TARGET_ARCH_ABI), armeabi-v7a)" << newLine

  643.             << "    LOCAL_ARM_MODE := arm" << newLine

  644.             << "endif" << newLine

  645.             << newLine

  646.             << "LOCAL_MODULE := juce_jni" << newLine

  647.             << "LOCAL_SRC_FILES := \\" << newLine;

  648. 

  649.         for (int i = 0; i < files.size(); ++i)

  650.             out << "  " << (files.getReference(i).isAbsolute() ? "" : "../")

  651.                 << escapeSpaces (files.getReference(i).toUnixStyle()) << "\\" << newLine;

  652. 

  653.         writeAndroidMkVariableList (out, "LOCAL_STATIC_LIBRARIES", getStaticLibrariesString());

  654.         writeAndroidMkVariableList (out, "LOCAL_SHARED_LIBRARIES", getSharedLibrariesString());

  655. 

  656.         out << newLine

  657.             << "ifeq ($(NDK_DEBUG),1)" << newLine;

  658.         writeConfigSettings (out, true);

  659.         out << "else" << newLine;

  660.         writeConfigSettings (out, false);

  661.         out << "endif" << newLine

  662.             << newLine

  663.             << "include $(BUILD_SHARED_LIBRARY)" << newLine;

  664. 

  665.         StringArray importModules (getCommaOrWhitespaceSeparatedItems (getStaticLibrariesString()));

  666.         importModules.addArray (getCommaOrWhitespaceSeparatedItems (getSharedLibrariesString()));

  667. 

  668.         for (int i = 0; i < importModules.size(); ++i)

  669.             out << "$(call import-module," << importModules[i] << ")" << newLine;

  670.     }

  671. 

  672.     void writeConfigSettings (OutputStream& out, bool forDebug) const

  673.     {

  674.         for (ConstConfigIterator config (*this); config.next();)

  675.         {

  676.             if (config->isDebug() == forDebug)

  677.             {

  678.                 const AndroidBuildConfiguration& androidConfig = dynamic_cast<const AndroidBuildConfiguration&> (*config);

  679. 

  680.                 String cppFlags;

  681.                 cppFlags << createCPPFlags (androidConfig)

  682.                          << (" " + replacePreprocessorTokens (androidConfig, getExtraCompilerFlagsString()).trim()).trimEnd()

  683.                          << newLine

  684.                          << getLDLIBS (androidConfig).trimEnd()

  685.                          << newLine;

  686. 

  687.                 out << "  LOCAL_CPPFLAGS += " << cppFlags;

  688.                 out << "  LOCAL_CFLAGS += " << cppFlags;

  689.                 break;

  690.             }

  691.         }

  692.     }

  693. 

  694.     String getLDLIBS (const AndroidBuildConfiguration& config) const

  695.     {

  696.         return "  LOCAL_LDLIBS :=" + config.getGCCLibraryPathFlags()

  697.                 + " -llog -lGLESv2 -landroid -lEGL" + getExternalLibraryFlags (config)

  698.                 + " " + replacePreprocessorTokens (config, getExtraLinkerFlagsString());

  699.     }

  700. 

  701.     String createIncludePathFlags (const BuildConfiguration& config) const

  702.     {

  703.         String flags;

  704.         StringArray searchPaths (extraSearchPaths);

  705.         searchPaths.addArray (config.getHeaderSearchPaths());

  706. 

  707.         searchPaths = getCleanedStringArray (searchPaths);

  708. 

  709.         for (int i = 0; i < searchPaths.size(); ++i)

  710.             flags << " -I " << FileHelpers::unixStylePath (replacePreprocessorTokens (config, searchPaths[i])).quoted();

  711. 

  712.         return flags;

  713.     }

  714. 

  715.     String createCPPFlags (const BuildConfiguration& config) const

  716.     {

  717.         StringPairArray defines;

  718.         defines.set ("JUCE_ANDROID", "1");

  719.         defines.set ("JUCE_ANDROID_API_VERSION", getMinimumSDKVersionString());

  720.         defines.set ("JUCE_ANDROID_ACTIVITY_CLASSNAME", getJNIActivityClassName().replaceCharacter ('/', '_'));

  721.         defines.set ("JUCE_ANDROID_ACTIVITY_CLASSPATH", "\\\"" + getJNIActivityClassName() + "\\\"");

  722. 

  723.         String flags ("-fsigned-char -fexceptions -frtti");

  724. 

  725.         if (config.isDebug())

  726.         {

  727.             flags << " -g";

  728.             defines.set ("DEBUG", "1");

  729.             defines.set ("_DEBUG", "1");

  730.         }

  731.         else

  732.         {

  733.             defines.set ("NDEBUG", "1");

  734.         }

  735. 

  736.         flags << createIncludePathFlags (config)

  737.               << " -O" << config.getGCCOptimisationFlag();

  738. 

  739.         if (isCPP11Enabled())

  740.             flags << " -std=c++11 -std=gnu++11"; // these flags seem to enable slightly different things on gcc, and both seem to be needed

  741. 

  742.         defines = mergePreprocessorDefs (defines, getAllPreprocessorDefs (config));

  743.         return flags + createGCCPreprocessorFlags (defines);

  744.     }

  745. 

  746.     //==============================================================================

  747.     XmlElement* createAntBuildXML() const

  748.     {

  749.         XmlElement* proj = new XmlElement ("project");

  750.         proj->setAttribute ("name", projectName);

  751.         proj->setAttribute ("default", "debug");

  752. 

  753.         proj->createNewChildElement ("loadproperties")->setAttribute ("srcFile", "local.properties");

  754.         proj->createNewChildElement ("loadproperties")->setAttribute ("srcFile", "project.properties");

  755. 

  756.         {

  757.             XmlElement* target = proj->createNewChildElement ("target");

  758.             target->setAttribute ("name", "clean");

  759.             target->setAttribute ("depends", "android_rules.clean");

  760. 

  761.             target->createNewChildElement ("delete")->setAttribute ("dir", "libs");

  762.             target->createNewChildElement ("delete")->setAttribute ("dir", "obj");

  763. 

  764.             XmlElement* executable = target->createNewChildElement ("exec");

  765.             executable->setAttribute ("executable", "${ndk.dir}/ndk-build");

  766.             executable->setAttribute ("dir", "${basedir}");

  767.             executable->setAttribute ("failonerror", "true");

  768. 

  769.             executable->createNewChildElement ("arg")->setAttribute ("value", "clean");

  770.         }

  771. 

  772.         {

  773.             XmlElement* target = proj->createNewChildElement ("target");

  774.             target->setAttribute ("name", "-pre-build");

  775. 

  776.             addDebugConditionClause (target, "makefileConfig", "Debug", "Release");

  777.             addDebugConditionClause (target, "ndkDebugValue", "NDK_DEBUG=1", "NDK_DEBUG=0");

  778. 

  779.             String debugABIs, releaseABIs;

  780. 

  781.             for (ConstConfigIterator config (*this); config.next();)

  782.             {

  783.                 const AndroidBuildConfiguration& androidConfig = dynamic_cast<const AndroidBuildConfiguration&> (*config);

  784. 

  785.                 if (config->isDebug())

  786.                     debugABIs = androidConfig.getArchitectures();

  787.                 else

  788.                     releaseABIs = androidConfig.getArchitectures();

  789.             }

  790. 

  791.             addDebugConditionClause (target, "app_abis", debugABIs, releaseABIs);

  792. 

  793.             XmlElement* executable = target->createNewChildElement ("exec");

  794.             executable->setAttribute ("executable", "${ndk.dir}/ndk-build");

  795.             executable->setAttribute ("dir", "${basedir}");

  796.             executable->setAttribute ("failonerror", "true");

  797. 

  798.             executable->createNewChildElement ("arg")->setAttribute ("value", "--jobs=4");

  799.             executable->createNewChildElement ("arg")->setAttribute ("value", "CONFIG=${makefileConfig}");

  800.             executable->createNewChildElement ("arg")->setAttribute ("value", "${ndkDebugValue}");

  801.             executable->createNewChildElement ("arg")->setAttribute ("value", "APP_ABI=${app_abis}");

  802. 

  803.             target->createNewChildElement ("delete")->setAttribute ("file", "${out.final.file}");

  804.             target->createNewChildElement ("delete")->setAttribute ("file", "${out.packaged.file}");

  805.         }

  806. 

  807.         proj->createNewChildElement ("import")->setAttribute ("file", "${sdk.dir}/tools/ant/build.xml");

  808. 

  809.         return proj;

  810.     }

  811. 

  812.     void addDebugConditionClause (XmlElement* target, const String& property,

  813.                                   const String& debugValue, const String& releaseValue) const

  814.     {

  815.         XmlElement* condition = target->createNewChildElement ("condition");

  816.         condition->setAttribute ("property", property);

  817.         condition->setAttribute ("value", debugValue);

  818.         condition->setAttribute ("else", releaseValue);

  819. 

  820.         XmlElement* equals = condition->createNewChildElement ("equals");

  821.         equals->setAttribute ("arg1", "${ant.project.invoked-targets}");

  822.         equals->setAttribute ("arg2", "debug");

  823.     }

  824. 

  825.     void writeProjectPropertiesFile (const File& file) const

  826.     {

  827.         MemoryOutputStream mo;

  828.         mo << "# This file is used to override default values used by the Ant build system." << newLine

  829.            << "# It is automatically generated - DO NOT EDIT IT or your changes will be lost!." << newLine

  830.            << newLine

  831.            << "target=" << getAppPlatform() << newLine

  832.            << newLine;

  833. 

  834.         overwriteFileIfDifferentOrThrow (file, mo);

  835.     }

  836. 

  837.     void writeLocalPropertiesFile (const File& file) const

  838.     {

  839.         MemoryOutputStream mo;

  840.         mo << "# This file is used to override default values used by the Ant build system." << newLine

  841.            << "# It is automatically generated by the Introjucer - DO NOT EDIT IT or your changes will be lost!." << newLine

  842.            << newLine

  843.            << "sdk.dir=" << escapeSpaces (replacePreprocessorDefs (getAllPreprocessorDefs(), getSDKPathString())) << newLine

  844.            << "ndk.dir=" << escapeSpaces (replacePreprocessorDefs (getAllPreprocessorDefs(), getNDKPathString())) << newLine

  845.            << "key.store=" << getKeyStoreString() << newLine

  846.            << "key.alias=" << getKeyAliasString() << newLine

  847.            << "key.store.password=" << getKeyStorePassString() << newLine

  848.            << "key.alias.password=" << getKeyAliasPassString() << newLine

  849.            << newLine;

  850. 

  851.         overwriteFileIfDifferentOrThrow (file, mo);

  852.     }

  853. 

  854.     void writeStringsFile (const File& file) const

  855.     {

  856.         XmlElement strings ("resources");

  857.         XmlElement* resourceName = strings.createNewChildElement ("string");

  858.         resourceName->setAttribute ("name", "app_name");

  859.         resourceName->addTextElement (projectName);

  860. 

  861.         writeXmlOrThrow (strings, file, "utf-8", 100);

  862.     }

  863. 

  864.     //==============================================================================

  865.     JUCE_DECLARE_NON_COPYABLE (AndroidAntProjectExporter)

  866. };