diff options
Diffstat (limited to 'dynamicbox_service/include/dynamicbox_conf.h')
| -rw-r--r-- | dynamicbox_service/include/dynamicbox_conf.h | 560 |
1 files changed, 560 insertions, 0 deletions
diff --git a/dynamicbox_service/include/dynamicbox_conf.h b/dynamicbox_service/include/dynamicbox_conf.h new file mode 100644 index 0000000..1d824aa --- /dev/null +++ b/dynamicbox_service/include/dynamicbox_conf.h @@ -0,0 +1,560 @@ +/* + * Copyright 2013 Samsung Electronics Co., Ltd + * + * Licensed under the Flora 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://floralicense.org/license/ + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef __DYNAMICBOX_SERVICE_CONF_H +#define __DYNAMICBOX_SERVICE_CONF_H + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @internal + * @brief Load a configuration file to the memory + * @since_tizen 2.3 + * @return int + * @retval #DBOX_STATUS_ERROR_NONE Successfully loaded + * @retval #DBOX_STATUS_ERROR_IO_ERROR Failed to access the configuration file + * @see dynamicbox_conf_reset() + */ +extern int dynamicbox_conf_load(void); + +/** + * @internal + * @brief Reset configuration data to its default values + * @since_tizen 2.3 + * @return void + * @see dynamicbox_conf_init() + */ +extern void dynamicbox_conf_reset(void); + +/** + * @internal + * @brief setup the configuration data using default values + * @since_tizen 2.3 + * @return void + * @see dynamicbox_conf_reset() + */ +extern void dynamicbox_conf_init(void); + +/** + * @internal + * @brief Get the flag of configuration loaded status + * @since_tizen 2.3 + * @return int 1 if it is loaded or 0 + * @see dynamicbox_conf_load() + */ +extern const int const dynamicbox_conf_is_loaded(void); + +/** + * @internal + * @brief configuration value getter + * @detail If your service provider intended to check the window stack directly, + * Refer this flag, if this returns 1, you should monitor the window stack + * to send the pause/resume event and it should be managed manually. + * @remarks this is just a recommendation to implement service provider, + * so the service provider's behaviour is depeneds on its implementation. + * @since_tizen 2.3 + * @return int 1 if the xmonitor should be enabled or 0 + */ +extern const int const dynamicbox_conf_use_xmonitor(void); + +/** + * @internal + * @brief configuration value getter for emergency disk mount information + * @detail if the system has not enough space to operate itself, the master provider allocate memory for + * its temporary storage. to save some files. + * @remarks this is only used for master service provider. + * all other service provider should not need to know this configuration value. + * but this API support to get current configuration. + * @since_tizen 2.3 + * @return const char * const + * @retval string emergency disk mount information includes options + * @retval @c NULL if there is no configuration information + */ +extern const char * const dynamicbox_conf_emergency_disk(void); + +/** + * @internal + * @brief if the master service provider should need to check the lcd status to pause/resume the service providers, + * this function will returns 1, or 0. + * @since_tizen 2.3 + * @return int + * @retval 1 need to care the lcd status by master service provider + * @retval 0 do not care it even if the lcd is off/on, do not send any pause/resume event to the service providers. + */ +extern const int const dynamicbox_conf_check_lcd(void); + +/** + * @internal + * @brief select the option whether use the event time of each event data from device or not. + * if this returns 1, the master service provider should keep its timestamp of each event data, + * or use the logical timestamp that is get by service provider. + * @since_tizen 2.3 + * @return int + * @retval 1 use the timestamp of event data + * @retval 0 use the system timestamp instead of event data of device + */ +extern const int const dynamicbox_conf_use_event_time(void); + +/** + * @internal + * @brief Get the configuration value for AUTO Alignment of canvas buffer. + * @details + * If the UIFW does not support the STRIDE information for rendering frame, + * This function will returns 1, then the dynamicbox will automatically aligning the buffer. + * @since_tizen 2.3 + * @return status of auto alignment. + * @retval 1 Content will be automatically aligned by dynamicbox. + * @retval 0 Content will be aligned by UIFW, using stride information. + */ +extern const int const dynamicbox_conf_auto_align(void); + +/** + * @internal + * @brief this returns formatted string that represents service list to be enabled + * format is "[service name1],[service name2],..."\n + * Candidate services are\n + * [dynamicbox]\n + * [badge]\n + * [notification]\n + * [utility]\n + * [shortcut]\n + * @since_tizen 2.3 + * @return string + * @retval NULL if there is no defined list. you should treat this as a default service list + */ +extern const char * const dynamicbox_conf_services(void); + +/** + * @internal + * @brief Get the configuration value of "use_sw_backend" + * if this returns 1, the provider should not use the Graphics buffer. + * @since_tizen 2.3 + * @return int + * @retval 1 true Use the S/W buffer such as heap instead of graphics buffer + * @retval 0 false You can choose S/W buffer or Graphics buffer + * @see dynamicbox_conf_provider_method() + */ +extern const int const dynamicbox_conf_use_sw_backend(void); + +/** + * @internal + * @brief Content sharing method for buffer type dbox (or gbar) + * it could be "pixmap", "shm", "file" + * in case of pixmap, the master service provider will try to allocate a resource from graphics sub system (ex, Xorg) + * in case of shm, it will try to allocate shared memory. + * in case of file, it will create a dummy file to write and read frame data from/to it. + * @since_tizen 2.3 + * @return const char * const + * @retval "pixmap" use the pixmap + * @retval "shm" use the shared memory + * @retval "file" use a file + */ +extern const char * const dynamicbox_conf_provider_method(void); + +/** + * @internal + * @brief if a debug mode is enabled, master will not launch the service provider directly. + * instead of it, the master will permanently waiting the launch of service provider. + * so the developer should launch the service provider with correct bundle data. + * and it should send the "hello" message to the master provider + * @since_tizen 2.3 + * @return int + * @retval 1 master will turn on the debug mode + * @retval 0 master will turn off the debug mode + */ +extern const int const dynamicbox_conf_debug_mode(void); + +/** + * @internal + * @brief If the overwrite content is enabled, the provider will not prepare to prevent from output file overwriting. + * To do it, the provider will renaming the output file right after it is created. + * @since_tizen 2.3 + * @return int bool + * @retval 1 Overwrite content + * @retval 0 Prevent from overwriting content + */ +extern const int const dynamicbox_conf_overwrite_content(void); + +/** + * @internal + */ +extern const int const dynamicbox_conf_com_core_thread(void); + +/** + * @internal + */ +extern const unsigned int const dynamicbox_conf_base_width(void); + +/** + * @internal + */ +extern const unsigned int const dynamicbox_conf_base_height(void); + +/** + * @internal + */ +extern const double const dynamicbox_conf_minimum_period(void); + +/** + * @internal + */ +extern const int const dynamicbox_conf_default_pixels(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_default_script(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_default_abi(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_default_gbar_group(void); + +/** + * @internal + */ +extern const double const dynamicbox_conf_default_period(void); + +/** + * @internal + */ +extern const double const dynamicbox_conf_default_packet_time(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_default_content(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_default_title(void); + +/** + * @internal + */ +extern const unsigned long const dynamicbox_conf_minimum_space(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_replace_tag(void); + +/** + * @internal + */ +extern const double const dynamicbox_conf_slave_ttl(void); + +/** + * @internal + */ +extern const double const dynamicbox_conf_slave_activate_time(void); + +/** + * @internal + */ +extern const double const dynamicbox_conf_slave_relaunch_time(void); + +/** + * @internal + */ +extern const int const dynamicbox_conf_slave_relaunch_count(void); + +/** + * @internal + */ +extern const int const dynamicbox_conf_max_log_line(void); + +/** + * @internal + */ +extern const int const dynamicbox_conf_max_log_file(void); + +/** + * @internal + */ +extern const unsigned long const dynamicbox_conf_sqlite_flush_max(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_db_path(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_reader_path(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_always_path(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_log_path(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_script_path(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_script_port(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_share_path(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_input_path(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_root_path(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_path(void); + +/** + * @internal + */ +extern const double const dynamicbox_conf_ping_time(void); + +/** + * @internal + */ +extern const int const dynamicbox_conf_slave_max_load(void); + +/** + * @internal + * @brief Get the configuration value for premultiplied alpha. + * @details + * If the system uses the premultiplied alpha for content, + * This function will returns 1. + * @since_tizen 2.3 + * @remarks This function only works with the inhouse provider. + * @return status of premultiplied alpha. + * @retval 1 Content rendered with premultiplied alpha. + * @retval 0 Content doesn't rendered with premultiplied alpha. + */ +extern const int const dynamicbox_conf_premultiplied_alpha(void); + +/** + * @internal + */ +extern const double const dynamicbox_conf_gbar_request_timeout(void); + +/** + * @internal + */ +extern const double const dynamicbox_conf_scale_width_factor(void); + +/** + * @internal + */ +extern const double const dynamicbox_conf_scale_height_factor(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_launch_key_name(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_launch_key_secured(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_launch_key_abi(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_launch_key_hw_acceleration(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_empty_content(void); + +/** + * @internal + */ +extern const char * const dynamicbox_conf_empty_title(void); + +/** + * @internal + */ +extern const int const dynamicbox_conf_extra_buffer_count(void); + +/** + * @internal + */ +extern const int const dynamicbox_conf_use_gettimeofday(void); + +/** + * @internal + */ +extern const int const dynamicbox_conf_slave_event_boost_off(void); + +/** + * @internal + */ +extern const int const dynamicbox_conf_slave_event_boost_on(void); + +/** + * @internal + */ +extern const double const dynamicbox_conf_event_filter(void); + +/** + * @internal + */ +extern const int const dynamicbox_conf_slave_limit_to_ttl(void); + +/** + * @internal + */ +extern const int const dynamicbox_conf_frame_skip(void); + +/** + * @internal + */ +extern const int const dynamicbox_conf_slave_auto_cache_flush(void); + +#define DYNAMICBOX_CONF_BASE_W dynamicbox_conf_base_width() +#define DYNAMICBOX_CONF_BASE_H dynamicbox_conf_base_height() + +#define DYNAMICBOX_CONF_EMERGENCY_DISK dynamicbox_conf_emergency_disk() +#define DYNAMICBOX_CONF_SCALE_WIDTH_FACTOR dynamicbox_conf_scale_width_factor() +#define DYNAMICBOX_CONF_SCALE_HEIGHT_FACTOR dynamicbox_conf_scale_height_factor() + +#define DYNAMICBOX_CONF_USE_SW_BACKEND dynamicbox_conf_use_sw_backend() +#define DYNAMICBOX_CONF_PROVIDER_METHOD dynamicbox_conf_provider_method() +#define DYNAMICBOX_CONF_DEBUG_MODE dynamicbox_conf_debug_mode() +#define DYNAMICBOX_CONF_OVERWRITE_CONTENT dynamicbox_conf_overwrite_content() +#define DYNAMICBOX_CONF_COM_CORE_THREAD dynamicbox_conf_com_core_thread() + +#define DYNAMICBOX_CONF_MINIMUM_PERIOD dynamicbox_conf_minimum_period() + +#define DYNAMICBOX_CONF_DEFAULT_SCRIPT dynamicbox_conf_default_script() +#define DYNAMICBOX_CONF_DEFAULT_ABI dynamicbox_conf_default_abi() +#define DYNAMICBOX_CONF_DEFAULT_GBAR_GROUP dynamicbox_conf_default_gbar_group() +#define DYNAMICBOX_CONF_DEFAULT_PERIOD dynamicbox_conf_default_period() +#define DYNAMICBOX_CONF_DEFAULT_PIXELS dynamicbox_conf_default_pixels() +#define DYNAMICBOX_CONF_PRIORITY_NO_CHANGE -1.0f + +#define DYNAMICBOX_CONF_BUNDLE_SLAVE_NAME dynamicbox_conf_launch_key_name() +#define DYNAMICBOX_CONF_BUNDLE_SLAVE_SECURED dynamicbox_conf_launch_key_secured() +#define DYNAMICBOX_CONF_BUNDLE_SLAVE_ABI dynamicbox_conf_launch_key_abi() +#define DYNAMICBOX_CONF_BUNDLE_SLAVE_HW_ACCELERATION dynamicbox_conf_launch_key_hw_acceleration() +#define DYNAMICBOX_CONF_PACKET_TIME dynamicbox_conf_default_packet_time() +#define DYNAMICBOX_CONF_CONTENT_NO_CHANGE dynamicbox_conf_empty_content() +#define DYNAMICBOX_CONF_TITLE_NO_CHANGE dynamicbox_conf_empty_title() +#define DYNAMICBOX_CONF_DEFAULT_TITLE dynamicbox_conf_default_title() +#define DYNAMICBOX_CONF_DEFAULT_CONTENT dynamicbox_conf_default_content() +#define DYNAMICBOX_CONF_MINIMUM_SPACE dynamicbox_conf_minimum_space() + +#define DYNAMICBOX_CONF_IMAGE_PATH dynamicbox_conf_share_path() +#define DYNAMICBOX_CONF_SCRIPT_PATH dynamicbox_conf_script_path() +#define DYNAMICBOX_CONF_SCRIPT_PORT_PATH dynamicbox_conf_script_port() +#define DYNAMICBOX_CONF_CONF_PATH dynamicbox_conf_path() +#define DYNAMICBOX_CONF_ROOT_PATH dynamicbox_conf_root_path() +#define DYNAMICBOX_CONF_LOG_PATH dynamicbox_conf_log_path() +#define DYNAMICBOX_CONF_READER_PATH dynamicbox_conf_reader_path() +#define DYNAMICBOX_CONF_ALWAYS_PATH dynamicbox_conf_always_path() +#define DYNAMICBOX_CONF_INPUT_PATH dynamicbox_conf_input_path() + +#define DYNAMICBOX_CONF_REPLACE_TAG_APPID dynamicbox_conf_replace_tag() +#define DYNAMICBOX_CONF_SLAVE_TTL dynamicbox_conf_slave_ttl() +#define DYNAMICBOX_CONF_SLAVE_ACTIVATE_TIME dynamicbox_conf_slave_activate_time() +#define DYNAMICBOX_CONF_SLAVE_RELAUNCH_TIME dynamicbox_conf_slave_relaunch_time() +#define DYNAMICBOX_CONF_SLAVE_RELAUNCH_COUNT dynamicbox_conf_slave_relaunch_count() + +#define DYNAMICBOX_CONF_MAX_LOG_LINE dynamicbox_conf_max_log_line() +#define DYNAMICBOX_CONF_MAX_LOG_FILE dynamicbox_conf_max_log_file() + +#define DYNAMICBOX_CONF_SQLITE_FLUSH_MAX dynamicbox_conf_sqlite_flush_max() +#define DYNAMICBOX_CONF_DBFILE dynamicbox_conf_db_path() + +#define DYNAMICBOX_CONF_GBAR_REQUEST_TIMEOUT dynamicbox_conf_gbar_request_timeout() + +#define DYNAMICBOX_CONF_SLAVE_MAX_LOAD dynamicbox_conf_slave_max_load() +#define DYNAMICBOX_CONF_DEFAULT_PING_TIME dynamicbox_conf_ping_time() +#define DYNAMICBOX_CONF_PREMULTIPLIED_COLOR dynamicbox_conf_premultiplied_alpha() +#define DYNAMICBOX_CONF_SERVICES dynamicbox_conf_services() +#define DYNAMICBOX_CONF_EXTRA_BUFFER_COUNT dynamicbox_conf_extra_buffer_count() + +#define DYNAMICBOX_CONF_SERVICE_DYNAMICBOX "[dynamicbox]" +#define DYNAMICBOX_CONF_SERVICE_NOTIFICATION "[notification]" +#define DYNAMICBOX_CONF_SERVICE_BADGE "[badge]" +#define DYNAMICBOX_CONF_SERVICE_SHORTCUT "[shortcut]" +#define DYNAMICBOX_CONF_SERVICE_UTILITY "[utility]" +#define DYNAMICBOX_CONF_SERVICE_FILE "[file]" + +#define DYNAMICBOX_CONF_PAUSED_FILE "/tmp/.live.paused" + +#define DYNAMICBOX_CONF_USE_XMONITOR dynamicbox_conf_use_xmonitor() +#define DYNAMICBOX_CONF_AUTO_ALIGN dynamicbox_conf_auto_align() +#define DYNAMICBOX_CONF_USE_EVENT_TIME dynamicbox_conf_use_event_time() +#define DYNAMICBOX_CONF_CHECK_LCD dynamicbox_conf_check_lcd() + +#define DYNAMICBOX_CONF_USE_GETTIMEOFDAY dynamicbox_conf_use_gettimeofday() + +#define DYNAMICBOX_CONF_DELAY_TIME 0.0000001f +#define DYNAMICBOX_CONF_DEFAULT_CLUSTER "user,created" +#define DYNAMICBOX_CONF_MINIMUM_REACTIVATION_TIME 10 + +#define DYNAMICBOX_CONF_SLAVE_EVENT_BOOST_ON dynamicbox_conf_slave_event_boost_on() +#define DYNAMICBOX_CONF_SLAVE_EVENT_BOOST_OFF dynamicbox_conf_slave_event_boost_off() +#define DYNAMICBOX_CONF_EVENT_FILTER dynamicbox_conf_event_filter() +#define DYNAMICBOX_CONF_SLAVE_LIMIT_TO_TTL dynamicbox_conf_slave_limit_to_ttl() +#define DYNAMICBOX_CONF_FRAME_SKIP dynamicbox_conf_frame_skip() +#define DYNAMICBOX_CONF_SLAVE_AUTO_CACHE_FLUSH dynamicbox_conf_slave_auto_cache_flush() + +#if !defined(VCONFKEY_MASTER_STARTED) +#define VCONFKEY_MASTER_STARTED "memory/data-provider-master/started" +#endif + +#if !defined(VCONFKEY_MASTER_RESTART_COUNT) +#define VCONFKEY_MASTER_RESTART_COUNT "memory/private/data-provider-master/restart_count" +#endif + +#ifdef __cplusplus +} +#endif + +#endif +/* End of a file */ |