Provide application info for deployment (i.e. name, author, license, icon, etc...).

aui_app unifies the packaging process across all platforms. For (mostly) all desktop platforms, it acts in collaboration with CPack.

ZIP, TGZ
DEB
NSIS
WIX
External

For the targets that require cross-compilation, it requires @ref AUI_BUILD_FOR to be set, and, in fact, does not involve CPack in such case.

For all packaging methods, aui_app assumes it is called once per CMake project. It is relevant for packaging methods that expect one "entrypoint" per package.

aui_app -> Android APK
aui_app -> iOS app bundle
aui_app -> Linux Flatpak
aui_app -> Linux AppImage

For this reason, aui_app populates some empty CPACK_* variables. This approach allows you not to bother about various installation methods but also override the variables if needed.

For more info about packaging methods, see Packaging Your App.

Syntax#

aui_app(TARGET aui.example.views
        NAME "AUI Examples"
        APPLE_BUNDLE_IDENTIFIER "aui.Examples"
        APPLE_SIGN_IDENTITY "iPhone Developer"
        APPLE_TEAM_ID "98S256N2KJ"
        ANDROID_PACKAGE "com.github.aui.examples"
        ICON "assets/img/logo.svg"
        )

aui_app(
    # common
    <TARGET <target-name>>
    <NAME <application-name>>
    [ICON <path-to-icon-svg>]
    [VENDOR <vendor-name>]
    [COPYRIGHT <copyright-string>]
    [VERSION <version>]
        
    [NO_INCLUDE_CPACK]
 
    # android only
    [ANDROID_PACKAGE <android-app-package>]
        
    # linux only
    [LINUX_DESKTOP <path-to-desktop-file>]
    
    # apple only
    [APPLE_TEAM_ID <apple-team-id>]
    [APPLE_BUNDLE_IDENTIFIER <bundle-identifier>]
    [APPLE_SIGN_IDENTITY <sign-identity>]
 
    # ios only
    [IOS_VERSION <target-ios-version>]
    [IOS_DEVICE <target-ios-device>]
    [IOS_CONTROLLER <custom-ios-controller-class-name>]
)

TARGET#

Specify main executable of the application which will be executed when your application is launched.

Platform	Required	Traits
Windows	+
Linux	+
macOS	+
Android	+
iOS	+

NAME#

Specify application display name that would appear in system's UIs (i.e., start menu, launchpad, desktop, control panel).

Platform	Required	Traits
Windows	+
Linux	+
macOS	+
Android	+
iOS	+

APP_NAME populates the following CMake variables (if undefined):

CPACK_BUNDLE_NAME = ${APP_NAME}
CPACK_PACKAGE_EXECUTABLES = "${_executable};${APP_NAME}"
CPACK_PACKAGE_INSTALL_DIRECTORY = ${APP_NAME}
CPACK_PACKAGE_NAME = ${APP_NAME}
MACOSX_BUNDLE_BUNDLE_NAME = ${APP_NAME}
MACOSX_BUNDLE_EXECUTABLE_NAME = ${APP_NAME}

The following additional variables and properties are affected:

_auib_weak_set_target_property(${APP_TARGET} CPACK_DESKTOP_SHORTCUTS "${APP_NAME}")
set(APP_APPLE_BUNDLE_IDENTIFIER ${APP_NAME})
set(EXECUTABLE_NAME ${APP_NAME})
set(PRODUCT_NAME ${APP_NAME})
set(_desktop "[Desktop Entry]\nName=${APP_NAME}\nExec=${_executable}\nType=Application\nTerminal=false\nCategories=Utility")
set_property(INSTALL bin/$<TARGET_FILE_NAME:${APP_TARGET}> PROPERTY CPACK_DESKTOP_SHORTCUTS "${APP_NAME}")
set_property(INSTALL bin/$<TARGET_FILE_NAME:${APP_TARGET}> PROPERTY CPACK_START_MENU_SHORTCUTS "${APP_NAME}")
set_target_properties(${APP_TARGET} PROPERTIES OUTPUT_NAME "${APP_NAME}") # rename the bundle to display name

ICON#

Specify SVG icon location (defaults to icon.svg if exists).

See Setting App Icon for best practices.

Platform	Required	Traits
Windows		generates `.ico` and `.bmp` files from your `svg`
Linux	+	generates Freedesktop-compliant icons from your `svg`
macOS	+	generates `*.icns` file from your `svg`
Android	+	generates icon assets from your `svg`
iOS	+	generates `*.icns` file from your `svg`

Using aui.toolbox, aui_app generates image assets from your icon depending on the app packaging method chosen.

APP_ICON populates the following CMake variables (if undefined):

CPACK_INNOSETUP_ICON_FILE = ${_ico}
CPACK_INNOSETUP_SETUP_WizardSmallImageFile = ${_ico}
CPACK_PACKAGE_ICON = ${_ico}
CPACK_WIX_PRODUCT_ICON = ${_ico}
CPACK_WIX_UI_BANNER = ${_ico}
CPACK_WIX_UI_DIALOG = ${_ico}

VENDOR#

Specify application author's name or company.

Platform	Required	Traits
Windows
Linux
macOS
Android
iOS

APP_VENDOR populates the following CMake variables (if undefined):

CPACK_PACKAGE_VENDOR = ${APP_VENDOR}

COPYRIGHT#

Specify application copyright string (not file)

Platform	Required	Traits
Windows
Linux		does not matter
macOS	+
Android
iOS	+

APP_COPYRIGHT populates the following CMake variables (if undefined):

MACOSX_BUNDLE_COPYRIGHT = ${APP_COPYRIGHT}

VERSION#

Specify application version. If not set, the value of PROJECT_VERSION used instead.

Platform	Required	Traits
Windows	+
Linux	+
macOS	+
Android	+
iOS	+

APP_VERSION populates the following CMake variables (if undefined):

CPACK_PACKAGE_FILE_NAME = ${CPACK_PACKAGE_NAME}-${APP_VERSION}-${_cmake_system_processor_lower}
CPACK_PACKAGE_VERSION = ${APP_VERSION}
MACOSX_BUNDLE_BUNDLE_VERSION = ${APP_VERSION}
MACOSX_BUNDLE_LONG_VERSION_STRING = ${APP_VERSION}
MACOSX_BUNDLE_SHORT_VERSION_STRING = ${APP_VERSION}

The following additional variables and properties are affected:

set(_aui_package_file_name "${CPACK_PACKAGE_NAME}-${APP_VERSION}-${_aui_package_file_name}")

NO_INCLUDE_CPACK#

By default aui_app includes CPack in order to allow to generate packages using CPack. You can disable this behaviour by specifying NO_INCLUDE_CPACK flag.

ANDROID_PACKAGE#

Android app package name.

Platform	Required	Traits
Windows
Linux
macOS
Android	+
iOS

LINUX_DESKTOP#

Specify custom *.desktop file. If not set, *.desktop file is generated from aui_app arguments.

Platform	Required	Traits
Linux	+

APPLE_TEAM_ID#

Specify your Apple Team ID (https://discussions.apple.com/thread/7942941).

Platform	Required	Traits
macOS	+
iOS	+

APPLE_BUNDLE_IDENTIFIER#

Specify bundle identifier. If not set, the value of NAME used instead.

Platform	Required	Traits
macOS
iOS

APPLE_SIGN_IDENTITY#

Specify Apple sign identity. Defaults to "iPhone Developer".

Platform	Required	Traits
macOS		unused
iOS

IOS_VERSION#

Specify target iOS platform. Defaults to "14.3".

Platform	Required	Traits
iOS

IOS_DEVICE#

Specify target iOS device. Applicable values are IPHONE, IPAD or BOTH. Defaults to BOTH.

Platform	Required	Traits
iOS

IOS_CONTROLLER#

Specify custom view controller class name. Defaults to AUIViewController.

Platform	Required	Traits
iOS

Contents