include/hiker/appmgr.h

Go to the documentation of this file.

/********************************************************************
 *
 * Copyright (c) 1999-2008 ACCESS CO., LTD. All rights reserved.
 * Copyright 2006, 2007, ACCESS Systems Americas, Inc. All rights reserved.
 *
 * Version: MPL 1.1/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is hikerproject.org code.
 *
 * The Initial Developer of the Original Code is ACCESS Systems Americas, Inc.
 *               Portions created by the Initial Developer are
 *      Copyright 2006-2007 the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * the GNU Lesser General Public License Version 2.1 (the "LGPL"), in which
 * case the provisions of the LGPL are applicable instead of those above.
 * If you wish to allow use of your version of this file only under the terms
 * of the LGPL, and not to allow others to use your version of this file under
 * the terms of the MPL, indicate your decision by deleting the provisions
 * above and replace them with the notice and other provisions required by
 * the LGPL. If you do not delete the provisions above, a recipient may use
 * your version of this file under the terms of either the MPL or the LGPL.
 * You may obtain a copy of the LGPL at http://www.gnu.org/licenses/lgpl.txt.
 *
 ********************************************************************/
#ifndef __ALP_APPLICATION_MGR_H_
#define __ALP_APPLICATION_MGR_H_

#include <sys/types.h>
#include <glib.h>
#include <hiker/ipc.h>
#include <hiker/types.h>
#include <hiker/config_defines.h>

#include <hiker/traces.h>


#ifdef __cplusplus
extern "C" {
#endif


int alp_main(int argc, char* argv[]);

typedef void (*AlpAppLaunchCompletionProc) (alp_status_t status, pid_t pid, gpointer cbData);
typedef void (*AlpRelaunchHandler) (int argc, char* argv[], gpointer cbData);
typedef void (*AlpExitHandler) (gpointer cbData);
typedef uint32_t AlpWatcherRef;


/*
        App Server error codes
*/
#define ALP_STATUS_APP_PARAM            ((alp_status_t)ALP_CLASS_APPSERVER | 0x00010000)
#define ALP_STATUS_APP_IPC              ((alp_status_t)ALP_CLASS_APPSERVER | 0x00020000)
#define ALP_STATUS_APP_NOT_FOUND        ((alp_status_t)ALP_CLASS_APPSERVER | 0x00030000)        // Something not found in some list.
#define ALP_STATUS_APP_NO_CONTEXT       ((alp_status_t)ALP_CLASS_APPSERVER | 0x00040000)        // No AlpAppContext.
#define ALP_STATUS_APP_NO_LAUNCHPAD ((alp_status_t)ALP_CLASS_APPSERVER | 0x00050000)    // missing launchpad
#define ALP_STATUS_APP_MSG              ((alp_status_t)ALP_CLASS_APPSERVER | 0x00060000)        // malformed message
#define ALP_STATUS_APP_RUNNING  ((alp_status_t)ALP_CLASS_APPSERVER | 0x00070000)        // app is already running (can't debug running apps)
#define ALP_STATUS_APP_MEM              ((alp_status_t)ALP_CLASS_APPSERVER | 0x00080000)        // Memory allocation failed.
#define ALP_STATUS_APP_LAUNCHPAD        ((alp_status_t)ALP_CLASS_APPSERVER | 0x00090000)        // Unable to launch. Probably a missing or malformed app.
#define ALP_STATUS_APP_BLOCKED  ((alp_status_t)ALP_CLASS_APPSERVER | 0x000A0000)        // The app is currently blocked from launching.
#define ALP_STATUS_APP_NOT_READY        ((alp_status_t)ALP_CLASS_APPSERVER | 0x000B0000)        // The system is not yet ready to launch primary apps.


// String constants for standard application properties (from the package manifest file)

#define ALP_APP_PROP_NAME               "name"
#define ALP_APP_PROP_VENDOR             "vendor"
#define ALP_APP_PROP_BACKGROUNDING      "backgrounding"
#define ALP_APP_PROP_HIDDEN             "hidden"                // Boolean.  "true" to hide app from users.
#define ALP_APP_PROP_JUMP_LIST  "jump-list"     // Default is to display primary launched apps only.  Set to "never" or "always" to override.
#define ALP_APP_PROP_ENABLE_THEME       "enable-theme"  // Boolean.  "true" to enable our theming engine.  Defaults to TRUE eventually, but for development ease, it will default to FALSE until the theming is mature.
#define ALP_APP_PROP_TRANSIENT  "transient"     // Boolean. "true" to be always retired when the primary app changes, regardless of whether or not the apps is launched with ALP_APP_TRANSIENT.
#define ALP_APP_PROP_UPDATE                     "update-menu"           // Command line to execute to update an application.  If present, the "Update" item is shown in Launcher "Applications" menu
#define ALP_APP_PROP_SETTINGS           "settings-menu"         // Command line to execute to edit an application's settings.  If present, the "Settings" item is shown in Launcher "Applications" menu
#define ALP_APP_PROP_DELETE                     "delete-menu"           // Command line to execute to delete an application.  If not present, application is deleted using Bundle Mgr
#define ALP_APP_PROP_PREVENT_DELETE     "prevent-delete"        // Boolean. "true" if application cannot be deleted
#define ALP_APP_PROP_PREVENT_COPY       "prevent-copy"          // Boolean. "true" if application cannot be copied
#define ALP_APP_PROP_ICON                       "icon"                          // Path to an icon resource or an ALP stock icon ID
#define ALP_APP_PROP_VERSION            "version"                       // Version string for application



// constants for standard application property values (from the package manifest file)


// Values for ALP_APP_PROP_BACKGROUNDING
#define ALP_APP_PROP_BG_UNSUPPORTED "unsupported"

#define ALP_APP_PROP_BG_SUPPORTED "supported"

#define ALP_APP_PROP_BG_PREFERRED "preferred"

#define ALP_APP_PROP_BG_REQUIRED "required"




typedef enum
{
        ALP_APP_BACKGROUND_UNSUPPORTED = 1,
        ALP_APP_BACKGROUND_SUPPORTED,
        ALP_APP_BACKGROUND_PREFERRED,
        ALP_APP_BACKGROUND_REQUIRED,

        ALP_APP_BACKGROUND_DEFAULT = ALP_APP_BACKGROUND_UNSUPPORTED
} AlpAppBackgroundingType;

typedef enum
{
        ALP_APP_MEMORY_STATE_UNKNOWN = 0,
        ALP_APP_MEMORY_STATE_LOW = 1,
        ALP_APP_MEMORY_STATE_LOW_RECOVER = 2,
        ALP_APP_MEMORY_STATE_CRITICAL = 3,
        ALP_APP_MEMORY_STATE_CRITICAL_RECOVER = 4,
} AlpAppMemoryState;


alp_status_t alp_app_launch(const char *bundleID, int argc, char *const argv[], pid_t *outPID);


alp_status_t alp_app_launch_async(const char *bundleID, int argc, char *const argv[], AlpAppLaunchCompletionProc completionProc, gpointer cbData);



alp_status_t alp_app_retire(const char *bundleID);



alp_status_t alp_app_retire_transients(void);



alp_status_t alp_app_exit(const char *bundleID);



alp_status_t alp_app_watcher_add(const char *bundleID, AlpWatcherRef *outWatcherRef, gboolean *outAppRan);


alp_status_t alp_app_watcher_check(AlpWatcherRef watcherRef, gboolean *outAppRan);


alp_status_t alp_app_watcher_block(AlpWatcherRef watcherRef, gboolean blockLaunch);


alp_status_t alp_app_watcher_remove(AlpWatcherRef watcherRef, gboolean *outAppRan);



gboolean alp_app_is_primary(void);



alp_status_t alp_app_current(char **outBundleID);



alp_status_t alp_app_set_backgrounding(AlpAppBackgroundingType newBackgrounding);


alp_status_t alp_app_get_backgrounding(AlpAppBackgroundingType *outBackgrounding);


alp_status_t alp_app_set_relaunch_handler(AlpRelaunchHandler procP, gpointer cbData);



alp_status_t alp_app_add_exit_handler(AlpExitHandler procP, gpointer cbData);


alp_status_t alp_app_remove_exit_handler(AlpExitHandler procP);


alp_status_t alp_app_remove_exit_handler_with_data(AlpExitHandler procP, gpointer cbData);



alp_status_t alp_app_reset_system(void);



gboolean alp_gremlins_is_running(void);



// Miscellaneous Constants:

// maximum size in bytes of app name/"id", including null terminator.  DOLATER: Document as policy somewhere.
#define PKG_ID_MAX_SIZE 256

// ALP settings keys:
#define ALP_APP_SETTING_APPMGR_DIR "/alp/appmgr"
#define ALP_APP_SETTING_DEFAULT_PRIMARY "/alp/appmgr/default-primary"
#define ALP_APP_SETTING_OTHER_PRIMARY "/alp/appmgr/other-primary"
#define ALP_APP_SETTING_LONG_PRESS_APP "/alp/appmgr/long-press-app"
//appserver takes to this app when home key is pressed. If this is not set then it will take to default-primary.
#define ALP_APP_SETTING_HOME_KEY_APP "/alp/appmgr/home-key-app"
//appserver takes to this app when end key is pressed. If this is not set appserver remains in the current app. 
#define ALP_APP_SETTING_END_KEY_APP "/alp/appmgr/end-key-app"

#define ALP_APP_SETTING_DISABLE_PRIMARY "/alp/appmgr/disable-primary-launches"
#define ALP_APP_SETTING_DEFAULT_ORIENTATION "/alp/appmgr/default-orientation" 

#define ALP_NOTIFY_EVENT_APP_MEMORY_LOW "/alp/appmgr/memory-low"
#define ALP_NOTIFY_EVENT_APP_MEMORY_LOW_RECOVER "/alp/appmgr/memory-low-recover"
#define ALP_NOTIFY_EVENT_APP_MEMORY_CRITICAL "/alp/appmgr/memory-critical"
#define ALP_NOTIFY_EVENT_APP_MEMORY_CRITICAL_RECOVER "/alp/appmgr/memory-critical-recover"


// Standard launch arguments

#define ALP_APP_PRIMARY "--alp-primary"


#define ALP_APP_BACKGROUNDED    "--alp-backgrounded"


#define ALP_APP_DISPLAY         "--alp-display"


#define ALP_APP_FIND            "--alp-find"


#define ALP_APP_FIND_CANCEL "--alp-find-cancel"


#define ALP_APP_DEBUG           "--alp-debug"


#define ALP_APP_NOTIFY          "--alp-notify"


#define ALP_APP_EXCHANGE                "--alp-exchange"


#define ALP_APP_ALARM           "--alp-alarm"


#define ALP_APP_ALARM_REASON    "--alp-alarm-reason"


#define ALP_APP_TRANSIENT       "--alp-transient"


#define ALP_APP_CLOSE_SESSION           "--alp-close-session"

#define ALP_APP_ALLOW_EARLY       "--alp-allow-early"



#ifdef __cplusplus
}       // extern "C"
#endif

#endif // __ALP_APPLICATION_MGR_H_

---

Generated on Wed Jul 30 07:06:39 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.