diff options
author | Sehong Na <sehong.na@samsung.com> | 2014-05-31 12:29:58 +0900 |
---|---|---|
committer | Sehong Na <sehong.na@samsung.com> | 2014-05-31 12:29:58 +0900 |
commit | c17dc905783b7ebe6043390fdfe29528380eb2ae (patch) | |
tree | 5c43f45a4291ea68da7610679d0f3b0a47cc4b06 | |
download | badge-c17dc905783b7ebe6043390fdfe29528380eb2ae.tar.gz badge-c17dc905783b7ebe6043390fdfe29528380eb2ae.tar.bz2 badge-c17dc905783b7ebe6043390fdfe29528380eb2ae.zip |
Initialize Tizen 2.3
45 files changed, 6269 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..61ba439 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +build.sh +build-stamp +cmake-tmp +configure-stamp +tmp diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100755 index 0000000..a78c820 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,89 @@ +CMAKE_MINIMUM_REQUIRED(VERSION 2.6) +PROJECT(badge C) + +SET(PREFIX ${CMAKE_INSTALL_PREFIX}) +SET(EXEC_PREFIX "\${prefix}") +SET(PROJECT_NAME "${PROJECT_NAME}") +SET(LIBDIR "\${exec_prefix}/lib") +SET(INCLUDEDIR "\${prefix}/include/${PROJECT_NAME}") +SET(DBDIR "/opt/dbspace") +SET(DBFILE ".${PROJECT_NAME}.db") +SET(DBPATH "${DBDIR}/${DBFILE}") +SET(VERSION_MAJOR 0) +SET(VERSION "${VERSION_MAJOR}.0.1") + +SET(CMAKE_SKIP_BUILD_RPATH true) + +SET(INSTALL_HEADERS_DEVEL + badge.h + badge_setting.h + badge_error.h +) + +SET(INSTALL_HEADERS_SERVICE_DEVEL + badge_setting_service.h + badge_db.h +) + +SET(SRCS + src/badge.c + src/badge_setting.c + src/badge_db.c + src/badge_ipc.c + src/badge_internal.c +) + +SET(SUBMODULES_SO + badge +) +SET(SUBMODULES_DEVEL + badge + badge-service +) +INCLUDE_DIRECTORIES(${CMAKE_SOURCE_DIR}/include) + +INCLUDE(FindPkgConfig) +pkg_check_modules(pkgs REQUIRED + aul + dlog + dbus-1 + dbus-glib-1 + vconf + com-core +) + +FOREACH(flag ${pkgs_CFLAGS}) + SET(EXTRA_CFLAGS "${EXTRA_CFLAGS} ${flag}") +ENDFOREACH(flag) + +SET(EXTRA_CFLAGS "${EXTRA_CFLAGS} -fvisibility=hidden -g -Wall -O2") + +SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${EXTRA_CFLAGS}") + +ADD_DEFINITIONS("-DPREFIX=\"${PREFIX}\"") +ADD_DEFINITIONS("-DBADGE_USE_DLOG") +ADD_DEFINITIONS("-DDBDIR=\"${DBDIR}\"") +ADD_DEFINITIONS("-DDBFILE=\"${DBFILE}\"") +ADD_DEFINITIONS("-DBADGE_DB_PATH=\"${DBPATH}\"") + +FOREACH(lib_file ${SUBMODULES_SO}) + ADD_LIBRARY(${lib_file} SHARED ${SRCS}) + TARGET_LINK_LIBRARIES(${lib_file} ${pkgs_LDFLAGS}) + SET_TARGET_PROPERTIES(${lib_file} PROPERTIES SOVERSION ${VERSION_MAJOR}) + SET_TARGET_PROPERTIES(${lib_file} PROPERTIES VERSION ${VERSION}) + INSTALL(TARGETS ${lib_file} DESTINATION lib COMPONENT RuntimeLibraries) +ENDFOREACH(lib_file) + +FOREACH(pcfile ${SUBMODULES_DEVEL}) + CONFIGURE_FILE(${pcfile}.pc.in ${pcfile}.pc @ONLY) + SET_DIRECTORY_PROPERTIES(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES "${pcfile}.pc") + INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/${pcfile}.pc DESTINATION lib/pkgconfig) +ENDFOREACH(pcfile) + +FOREACH(hfile ${INSTALL_HEADERS_DEVEL}) + INSTALL(FILES ${CMAKE_SOURCE_DIR}/include/${hfile} DESTINATION include/${PROJECT_NAME}) +ENDFOREACH(hfile) + +FOREACH(hfile ${INSTALL_HEADERS_SERVICE_DEVEL}) + INSTALL(FILES ${CMAKE_SOURCE_DIR}/include/${hfile} DESTINATION include/${PROJECT_NAME}/service) +ENDFOREACH(hfile) @@ -0,0 +1,204 @@ +Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved. + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + + 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. + diff --git a/TC/_export_env.sh b/TC/_export_env.sh new file mode 100755 index 0000000..7a317f8 --- /dev/null +++ b/TC/_export_env.sh @@ -0,0 +1,10 @@ +#!/bin/sh + +source ./config + +export TET_INSTALL_PATH=$TET_INSTALL_HOST_PATH # tetware root path +#export TET_TARGET_PATH=$TET_INSTALL_PATH/tetware-simulator # tetware target path +export TET_TARGET_PATH=$TET_INSTALL_PATH/tetware-target # tetware target path +export PATH=$TET_TARGET_PATH/bin:$PATH +export LD_LIBRARY_PATH=$TET_TARGET_PATH/lib/tet3:$LD_LIBRARY_PATH +export TET_ROOT=$TET_TARGET_PATH diff --git a/TC/_export_target_env.sh b/TC/_export_target_env.sh new file mode 100755 index 0000000..5e005cf --- /dev/null +++ b/TC/_export_target_env.sh @@ -0,0 +1,9 @@ +#!/bin/sh +. ./config + +export TET_INSTALL_PATH=$TET_INSTALL_TARGET_PATH # path to path +#export TET_TARGET_PATH=$TET_INSTALL_PATH/tetware-simulator +export TET_TARGET_PATH=$TET_INSTALL_PATH/tetware-target +export PATH=$TET_TARGET_PATH/bin:$PATH +export LD_LIBRARY_PATH=$TET_TARGET_PATH/lib/tet3:$LD_LIBRARY_PATH +export TET_ROOT=$TET_TARGET_PATH diff --git a/TC/clean.sh b/TC/clean.sh new file mode 100755 index 0000000..29743e0 --- /dev/null +++ b/TC/clean.sh @@ -0,0 +1,11 @@ +#!/bin/sh + +. ./_export_env.sh # setting environment variables + +export TET_SUITE_ROOT=`pwd` +RESULT_DIR=results + +tcc -c -p ./ # executing tcc, with clean option (-c) +rm -r $RESULT_DIR +rm -r tet_tmp_dir +rm testcase/tet_captured diff --git a/TC/config b/TC/config new file mode 100755 index 0000000..e31ce9b --- /dev/null +++ b/TC/config @@ -0,0 +1,3 @@ +PKG_NAME=badge +TET_INSTALL_HOST_PATH=/var/tmp/dts_fw/TC/TETware +TET_INSTALL_TARGET_PATH=/opt/home/$PKG_NAME/TETware diff --git a/TC/push.sh b/TC/push.sh new file mode 100755 index 0000000..5eb9510 --- /dev/null +++ b/TC/push.sh @@ -0,0 +1,13 @@ +#!/bin/sh + +. ./config + +TC_PATH=/opt/home/$PKG_NAME + +echo $TC_PATH + +sdb shell "mkdir -p $TC_PATH" + +sdb push . $TC_PATH + + diff --git a/TC/run.sh b/TC/run.sh new file mode 100755 index 0000000..cec5778 --- /dev/null +++ b/TC/run.sh @@ -0,0 +1,15 @@ +#!/bin/sh + +source ./_export_target_env.sh + +export TET_SUITE_ROOT=`pwd` +FILE_NAME_EXTENSION=`date +%s` + +RESULT_DIR=results +HTML_RESULT=$RESULT_DIR/exec-tar-result-$FILE_NAME_EXTENSION.html +JOURNAL_RESULT=$RESULT_DIR/exec-tar-result-$FILE_NAME_EXTENSION.journal + +mkdir -p $RESULT_DIR + +tcc -e -j $JOURNAL_RESULT -p ./ +grw -c 7 -f chtml -o $HTML_RESULT $JOURNAL_RESULT diff --git a/TC/testcase/Makefile b/TC/testcase/Makefile new file mode 100755 index 0000000..2f5ca3d --- /dev/null +++ b/TC/testcase/Makefile @@ -0,0 +1,26 @@ +include ../config + +CC ?= gcc + +C_FILES = $(shell ls *.c) + +PKGS = $(PKG_NAME) +PKGS += glib-2.0 +LDFLAGS = `pkg-config --libs $(PKGS)` +LDFLAGS += $(TET_ROOT)/lib/tet3/tcm_s.o +LDFLAGS += -L$(TET_ROOT)/lib/tet3 -ltcm_s +LDFLAGS += -L$(TET_ROOT)/lib/tet3 -lapi_s + +CFLAGS = -I. `pkg-config --cflags $(PKGS)` +CFLAGS += -I$(TET_ROOT)/inc/tet3 +CFLAGS += -Wall + +TCS := $(shell ls -1 *.c | cut -d. -f1) + +all: $(TCS) + +%: %.c + $(CC) -o $@ $< $(CFLAGS) $(LDFLAGS) + +clean: + rm -f $(TCS) diff --git a/TC/testcase/tslist b/TC/testcase/tslist new file mode 100755 index 0000000..dc99875 --- /dev/null +++ b/TC/testcase/tslist @@ -0,0 +1,2 @@ +/testcase/utc_badge +/testcase/utc_badge_setting
\ No newline at end of file diff --git a/TC/testcase/utc_badge.c b/TC/testcase/utc_badge.c new file mode 100755 index 0000000..b3667d2 --- /dev/null +++ b/TC/testcase/utc_badge.c @@ -0,0 +1,384 @@ +/* + * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved + * + * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * 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. + */ + +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <unistd.h> +#include <fcntl.h> +#include <libintl.h> +#include <tet_api.h> +#include <badge.h> + +#define TEST_PKG "org.tizen.tetware" + +enum { + POSITIVE_TC_IDX = 0x01, + NEGATIVE_TC_IDX, +}; + +static void startup(void); +static void cleanup(void); + +static void utc_badge_create_n(void); +static void utc_badge_create_p(void); +static void utc_badge_remove_n(void); +static void utc_badge_remove_p(void); +static void utc_badge_set_count_n(void); +static void utc_badge_set_count_p(void); +static void utc_badge_get_count_n(void); +static void utc_badge_get_count_p(void); +static void utc_badge_set_display_n(void); +static void utc_badge_set_display_p(void); +static void utc_badge_get_display_n(void); +static void utc_badge_get_display_p(void); +static void utc_badge_is_existing_n(void); +static void utc_badge_is_existing_p(void); +static void utc_badge_foreach_existed_n(void); +static void utc_badge_foreach_existed_p(void); +static void utc_badge_register_changed_cb_n(void); +static void utc_badge_register_changed_cb_p(void); +static void utc_badge_unregister_changed_n(void); +static void utc_badge_unregister_changed_p(void); + +#define TEST_PKG "org.tizen.tetware" + +void (*tet_startup)(void) = startup; +void (*tet_cleanup)(void) = cleanup; + +struct tet_testlist tet_testlist[] = { + {utc_badge_create_n , NEGATIVE_TC_IDX}, + {utc_badge_create_p, POSITIVE_TC_IDX}, + {utc_badge_remove_n , NEGATIVE_TC_IDX}, + {utc_badge_remove_p, POSITIVE_TC_IDX}, + {utc_badge_set_count_n , NEGATIVE_TC_IDX}, + {utc_badge_set_count_p, POSITIVE_TC_IDX}, + {utc_badge_get_count_n , NEGATIVE_TC_IDX}, + {utc_badge_get_count_p, POSITIVE_TC_IDX}, + {utc_badge_set_display_n , NEGATIVE_TC_IDX}, + {utc_badge_set_display_p, POSITIVE_TC_IDX}, + {utc_badge_get_display_n , NEGATIVE_TC_IDX}, + {utc_badge_get_display_p, POSITIVE_TC_IDX}, + {utc_badge_is_existing_n , NEGATIVE_TC_IDX}, + {utc_badge_is_existing_p, POSITIVE_TC_IDX}, + {utc_badge_foreach_existed_n , NEGATIVE_TC_IDX}, + {utc_badge_foreach_existed_p, POSITIVE_TC_IDX}, + {utc_badge_register_changed_cb_n , NEGATIVE_TC_IDX}, + {utc_badge_register_changed_cb_p, POSITIVE_TC_IDX}, + {utc_badge_unregister_changed_n , NEGATIVE_TC_IDX}, + {utc_badge_unregister_changed_p, POSITIVE_TC_IDX}, + { NULL, 0 }, +}; + +static void _badge_foreach_cb(const char *pkgname, unsigned int count, void *data) { + +} + +static void _badge_changed_cb(unsigned int action, const char *pkgname, + unsigned int count, void *data) { + +} + +static void startup(void) +{ + /* start of TC */ + tet_printf("\n TC start"); + badge_remove(TEST_PKG); +} + + +static void cleanup(void) +{ + /* end of TC */ + tet_printf("\n TC end"); +} + +/** + * @brief Negative test case of badge_create() + */ +static void utc_badge_create_n(void) +{ + int ret; + + ret = badge_create(NULL, NULL); + + dts_check_eq("badge_create", ret, BADGE_ERROR_INVALID_DATA, + "Must return BADGE_ERROR_INVALID_DATA in case of invalid parameter"); +} + +/** + * @brief Positive test case of badge_create() + */ +static void utc_badge_create_p(void) +{ + int ret; + + ret = badge_create(TEST_PKG, TEST_PKG); + + dts_check_eq("badge_create", ret, BADGE_ERROR_NONE, + "Must return BADGE_ERROR_NONE in case of invalid parameter"); +} + + +/** + * @brief Negative test case of badge_remove() + */ +static void utc_badge_remove_n(void) +{ + int ret; + + ret = badge_remove(NULL); + + dts_check_eq("badge_remove", ret, BADGE_ERROR_INVALID_DATA, + "Must return BADGE_ERROR_INVALID_DATA in case of invalid parameter"); +} + +/** + * @brief Positive test case of badge_remove() + */ +static void utc_badge_remove_p(void) +{ + int ret; + + ret = badge_create(TEST_PKG, TEST_PKG); + ret = badge_remove(TEST_PKG); + + dts_check_eq("badge_create", ret, BADGE_ERROR_NONE, + "Must return BADGE_ERROR_NONE in case of invalid parameter"); +} + +/** + * @brief Negative test case of badge_set_count() + */ +static void utc_badge_set_count_n(void) +{ + int ret; + + ret = badge_set_count(NULL, 0); + + dts_check_eq("badge_set_count", ret, BADGE_ERROR_INVALID_DATA, + "Must return BADGE_ERROR_INVALID_DATA in case of invalid parameter"); +} + +/** + * @brief Positive test case of badge_set_count() + */ +static void utc_badge_set_count_p(void) +{ + int ret; + + ret = badge_create(TEST_PKG, TEST_PKG); + ret = badge_set_count(TEST_PKG, 1); + + dts_check_eq("badge_set_count", ret, BADGE_ERROR_NONE, + "Must return BADGE_ERROR_NONE in case of invalid parameter"); +} + + +/** + * @brief Negative test case of badge_get_count() + */ +static void utc_badge_get_count_n(void) +{ + int ret; + + ret = badge_get_count(NULL, NULL); + + dts_check_eq("badge_get_count", ret, BADGE_ERROR_INVALID_DATA, + "Must return BADGE_ERROR_INVALID_DATA in case of invalid parameter"); +} + +/** + * @brief Positive test case of badge_get_count() + */ +static void utc_badge_get_count_p(void) +{ + int ret; + int count = 0; + + ret = badge_create(TEST_PKG, TEST_PKG); + ret = badge_set_count(TEST_PKG, 1); + ret = badge_get_count(TEST_PKG, &count); + + dts_check_eq("badge_get_count", ret, BADGE_ERROR_NONE, + "Must return BADGE_ERROR_NONE in case of invalid parameter"); +} + +/** + * @brief Negative test case of badge_set_display() + */ +static void utc_badge_set_display_n(void) +{ + int ret; + + ret = badge_set_display(NULL, 0); + + dts_check_eq("badge_set_display", ret, BADGE_ERROR_INVALID_DATA, + "Must return BADGE_ERROR_INVALID_DATA in case of invalid parameter"); +} + +/** + * @brief Positive test case of badge_set_display() + */ +static void utc_badge_set_display_p(void) +{ + int ret; + int count = 0; + + ret = badge_create(TEST_PKG, TEST_PKG); + ret = badge_set_count(TEST_PKG, 1); + ret = badge_set_display(TEST_PKG, 1); + + dts_check_eq("badge_set_display", ret, BADGE_ERROR_NONE, + "Must return BADGE_ERROR_NONE in case of invalid parameter"); +} + +/** + * @brief Negative test case of badge_get_display() + */ +static void utc_badge_get_display_n(void) +{ + int ret; + + ret = badge_get_display(NULL, NULL); + + dts_check_eq("badge_get_display", ret, BADGE_ERROR_INVALID_DATA, + "Must return BADGE_ERROR_INVALID_DATA in case of invalid parameter"); +} + +/** + * @brief Positive test case of badge_get_display() + */ +static void utc_badge_get_display_p(void) +{ + int ret; + int count = 0; + + ret = badge_create(TEST_PKG, TEST_PKG); + ret = badge_set_count(TEST_PKG, 1); + ret = badge_get_display(TEST_PKG, &count); + + dts_check_eq("badge_get_display", ret, BADGE_ERROR_NONE, + "Must return BADGE_ERROR_NONE in case of invalid parameter"); +} + +/** + * @brief Negative test case of badge_is_existing() + */ +static void utc_badge_is_existing_n(void) +{ + int ret; + + ret = badge_is_existing(NULL, NULL); + + dts_check_eq("badge_is_existing", ret, BADGE_ERROR_INVALID_DATA, + "Must return BADGE_ERROR_INVALID_DATA in case of invalid parameter"); +} + +/** + * @brief Positive test case of badge_is_existing() + */ +static void utc_badge_is_existing_p(void) +{ + int ret; + int is_existing; + + ret = badge_create(TEST_PKG, TEST_PKG); + ret = badge_is_existing(TEST_PKG, &is_existing); + + dts_check_eq("badge_is_existing", ret, BADGE_ERROR_NONE, + "Must return BADGE_ERROR_NONE in case of invalid parameter"); +} + +/** + * @brief Negative test case of badge_foreach_existed() + */ +static void utc_badge_foreach_existed_n(void) +{ + int ret; + + ret = badge_foreach_existed(NULL, NULL); + + dts_check_eq("badge_foreach_existed", ret, BADGE_ERROR_INVALID_DATA, + "Must return BADGE_ERROR_INVALID_DATA in case of invalid parameter"); +} + +/** + * @brief Positive test case of badge_foreach_existed() + */ +static void utc_badge_foreach_existed_p(void) +{ + int ret; + + ret = badge_create(TEST_PKG, TEST_PKG); + ret = badge_foreach_existed(_badge_foreach_cb, NULL); + + dts_check_eq("badge_foreach_existed", ret, BADGE_ERROR_NONE, + "Must return BADGE_ERROR_NONE in case of invalid parameter"); +} + +/** + * @brief Negative test case of badge_register_changed_cb() + */ +static void utc_badge_register_changed_cb_n(void) +{ + int ret; + + ret = badge_register_changed_cb(NULL, NULL); + + dts_check_eq("badge_register_changed_cb", ret, BADGE_ERROR_INVALID_DATA, + "Must return BADGE_ERROR_INVALID_DATA in case of invalid parameter"); +} + +/** + * @brief Positive test case of badge_register_changed_cb() + */ +static void utc_badge_register_changed_cb_p(void) +{ + int ret; + + ret = badge_register_changed_cb(_badge_changed_cb, NULL); + + dts_check_eq("badge_register_changed_cb", ret, BADGE_ERROR_NONE, + "Must return BADGE_ERROR_NONE in case of invalid parameter"); +} + +/** + * @brief Negative test case of badge_unregister_changed() + */ +static void utc_badge_unregister_changed_n(void) +{ + int ret; + + ret = badge_unregister_changed_cb(NULL); + + dts_check_eq("badge_unregister_changed_cb", ret, BADGE_ERROR_INVALID_DATA, + "Must return BADGE_ERROR_INVALID_DATA in case of invalid parameter"); +} + +/** + * @brief Positive test case of badge_unregister_changed() + */ +static void utc_badge_unregister_changed_p(void) +{ + int ret; + + ret = badge_register_changed_cb(_badge_changed_cb, NULL); + ret = badge_unregister_changed_cb(_badge_changed_cb); + + dts_check_eq("badge_unregister_changed_cb", ret, BADGE_ERROR_NONE, + "Must return BADGE_ERROR_NONE in case of invalid parameter"); +} diff --git a/TC/testcase/utc_badge_setting.c b/TC/testcase/utc_badge_setting.c new file mode 100755 index 0000000..179ace3 --- /dev/null +++ b/TC/testcase/utc_badge_setting.c @@ -0,0 +1,115 @@ +/* + * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved + * + * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * 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. + */ + +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <unistd.h> +#include <fcntl.h> +#include <libintl.h> +#include <tet_api.h> +#include <badge.h> + +#define TEST_PKG "org.tizen.tetware" + +enum { + POSITIVE_TC_IDX = 0x01, + NEGATIVE_TC_IDX, +}; + +static void startup(void); +static void cleanup(void); + +static void utc_badge_setting_property_set_n(void); +static void utc_badge_setting_property_set_p(void); +static void utc_badge_setting_property_get_n(void); +static void utc_badge_setting_property_get_p(void); + +#define TEST_PKG "org.tizen.tetware" + +void (*tet_startup)(void) = startup; +void (*tet_cleanup)(void) = cleanup; + +struct tet_testlist tet_testlist[] = { + {utc_badge_setting_property_set_n, NEGATIVE_TC_IDX}, + {utc_badge_setting_property_set_p, POSITIVE_TC_IDX}, + {utc_badge_setting_property_get_n, NEGATIVE_TC_IDX}, + {utc_badge_setting_property_get_p, POSITIVE_TC_IDX}, + { NULL, 0 }, +}; + +static void startup(void) +{ + /* start of TC */ + tet_printf("\n TC start"); +} + + +static void cleanup(void) +{ + /* end of TC */ + tet_printf("\n TC end"); +} + +/** + * @brief Negative test case of badge_setting_property_set() + */ +static void utc_badge_setting_property_set_n(void) +{ + int ret; + + ret = badge_setting_property_set(NULL, NULL, NULL); + dts_check_eq("badge_setting_property_set", ret, BADGE_ERROR_INVALID_DATA, + "Must return BADGE_ERROR_INVALID_DATA in case of invalid parameter"); +} + +/** + * @brief Positive test case of badge_setting_property_set() + */ +static void utc_badge_setting_property_set_p(void) +{ + int ret; + + ret = badge_setting_property_set(TEST_PKG, "OPT_BADGE", "ON"); + /*Invalid parameter test*/ + dts_check_ne("badge_setting_property_set", ret, BADGE_ERROR_INVALID_DATA, + "Must return BADGE_ERROR_NONE in case of valid parameter"); +} + +/** + * @brief Negative test case of badge_setting_property_get() + */ +static void utc_badge_setting_property_get_n(void) +{ + int ret; + + ret = badge_setting_property_get(NULL, NULL, NULL); + dts_check_eq("badge_setting_property_get", ret, BADGE_ERROR_INVALID_DATA, + "Must return BADGE_ERROR_INVALID_DATA in case of invalid parameter"); +} + +/** + * @brief Positive test case of badge_setting_property_get() + */ +static void utc_badge_setting_property_get_p(void) +{ + int ret; + char *value = NULL; + + ret = badge_setting_property_get(TEST_PKG, "OPT_BADGE", &value); + dts_check_ne("badge_setting_property_get", ret, BADGE_ERROR_INVALID_DATA, + "Must return BADGE_ERROR_NONE in case of valid parameter"); +} diff --git a/TC/tet_scen b/TC/tet_scen new file mode 100755 index 0000000..03f029a --- /dev/null +++ b/TC/tet_scen @@ -0,0 +1,7 @@ +all + ^TEST +##### Scenarios for TEST ##### + +# Test scenario +TEST + :include:/testcase/tslist diff --git a/TC/tetbuild.cfg b/TC/tetbuild.cfg new file mode 100755 index 0000000..f7eda55 --- /dev/null +++ b/TC/tetbuild.cfg @@ -0,0 +1,5 @@ +TET_OUTPUT_CAPTURE=True # capture option for build operation checking +TET_BUILD_TOOL=make # build with using make command +TET_BUILD_FILE=-f Makefile # execution file (Makefile) for build +TET_API_COMPLIANT=True # use TET API in Test Case ? +TET_PASS_TC_NAME=True # report passed TC name in Journal file? diff --git a/TC/tetclean.cfg b/TC/tetclean.cfg new file mode 100755 index 0000000..2a0477a --- /dev/null +++ b/TC/tetclean.cfg @@ -0,0 +1,5 @@ +TET_OUTPUT_CAPTURE=True # capture option +TET_CLEAN_TOOL= make clean # clean tool +TET_CLEAN_FILE= Makefile # file for clean +TET_API_COMPLIANT=True # TET API useage +TET_PASS_TC_NAME=True # showing name , passed TC diff --git a/TC/tetexec.cfg b/TC/tetexec.cfg new file mode 100755 index 0000000..ef3e452 --- /dev/null +++ b/TC/tetexec.cfg @@ -0,0 +1,5 @@ +TET_OUTPUT_CAPTURE=True # capturing execution or not +TET_EXEC_TOOL= # ex) exec : execution tool set up/ Optional +TET_EXEC_FILE= # ex) exectool : execution file/ Optional +TET_API_COMPLIANT=True # Test case or Tool usesTET API? +TET_PASS_TC_NAME=True # showing Passed TC name ? diff --git a/badge-service.pc.in b/badge-service.pc.in new file mode 100755 index 0000000..7864b50 --- /dev/null +++ b/badge-service.pc.in @@ -0,0 +1,11 @@ +prefix=@PREFIX@ +exec_prefix=@EXEC_PREFIX@ +libdir=@LIBDIR@ +includedir=@INCLUDEDIR@/service + +Name: badge +Description: Badge supporting library +Version: @VERSION@ +Requires: +Libs: -L${libdir} -lbadge +Cflags: -I${includedir} diff --git a/badge.manifest b/badge.manifest new file mode 100755 index 0000000..b20b569 --- /dev/null +++ b/badge.manifest @@ -0,0 +1,16 @@ +<manifest> + <define> + <domain name="badge"/> + <provide> + <label name="badge::db"/> + </provide> + </define> + <assign> + <filesystem path="/usr/lib/libbadge.so.0.0.1" label="_"/> + <filesystem path="/usr/lib/libbadge.so.0" label="_"/> + <filesystem path="/usr/lib/libbadge.so" label="_"/> + </assign> + <request> + <domain name="badge"/> + </request> +</manifest> diff --git a/badge.pc.in b/badge.pc.in new file mode 100644 index 0000000..3ab8330 --- /dev/null +++ b/badge.pc.in @@ -0,0 +1,11 @@ +prefix=@PREFIX@ +exec_prefix=@EXEC_PREFIX@ +libdir=@LIBDIR@ +includedir=@INCLUDEDIR@ + +Name: badge +Description: Badge supporting library +Version: @VERSION@ +Requires: +Libs: -L${libdir} -lbadge +Cflags: -I${includedir} diff --git a/debian/changelog b/debian/changelog new file mode 100644 index 0000000..19f748f --- /dev/null +++ b/debian/changelog @@ -0,0 +1,15 @@ +badge (0.0.1-2) unstable; urgency=low + + * remove group_id + * Git: slp/pkgs/b/badge + * Tag: badge_0.0.1-2 + + -- Jeonghoon Park <jh1979.park@samsung.com> Thu, 31 May 2012 15:33:36 +0900 + +badge (0.0.1-1) unstable; urgency=low + + * Initial Release. + * Git: slp/pkgs/b/badge + * Tag: badge_0.0.1-1 + + -- Jeonghoon Park <jh1979.park@samsung.com> Mon, 27 Feb 2012 14:14:00 +0900 diff --git a/debian/compat b/debian/compat new file mode 100644 index 0000000..7ed6ff8 --- /dev/null +++ b/debian/compat @@ -0,0 +1 @@ +5 diff --git a/debian/control b/debian/control new file mode 100644 index 0000000..bddd5e7 --- /dev/null +++ b/debian/control @@ -0,0 +1,25 @@ +Source: badge +Section: libs +Priority: optional +Maintainer: Jeonghoon Park <jh1979.park@samsung.com>, Young-joo Park <yjoo93.park@samsung.com> +Build-Depends: debhelper (>= 5), dlog-dev, libaul-1-dev, libdbus-1-dev, libdbus-glib-1-dev +Standards-Version: 3.7.2 + +Package: libbadge +Section: libs +Architecture: any +Depends: ${shlibs:Depends}, ${misc:Depends} +Description: Badge supporting library (shared object) + +Package: libbadge-dev +Section: libs +Architecture: any +Depends: libbadge (= ${Source-Version}) +Description: Badge supporting library (development) + +Package: libbadge-dbg +Section: debug +Architecture: any +Depends: ${misc:Depends}, libbadge (= ${Source-Version}) +Description: Badge supporting library (unstripped) + diff --git a/debian/dirs b/debian/dirs new file mode 100644 index 0000000..ca882bb --- /dev/null +++ b/debian/dirs @@ -0,0 +1,2 @@ +usr/bin +usr/sbin diff --git a/debian/docs b/debian/docs new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/debian/docs diff --git a/debian/libbadge-dev.install.in b/debian/libbadge-dev.install.in new file mode 100644 index 0000000..1bc0c16 --- /dev/null +++ b/debian/libbadge-dev.install.in @@ -0,0 +1,2 @@ +@PREFIX@/include/@PROJECT_NAME@/*.h +@PREFIX@/lib/pkgconfig/*.pc diff --git a/debian/libbadge.install.in b/debian/libbadge.install.in new file mode 100644 index 0000000..bf766f0 --- /dev/null +++ b/debian/libbadge.install.in @@ -0,0 +1 @@ +@PREFIX@/lib/*.so* diff --git a/debian/libbadge.postinst.in b/debian/libbadge.postinst.in new file mode 100644 index 0000000..d80c0ea --- /dev/null +++ b/debian/libbadge.postinst.in @@ -0,0 +1,27 @@ +#!/bin/sh + +if [ ! -d @DATADIR@/dbspace ] +then + mkdir -p @DATADIR@/dbspace +fi + +if [ ! -f @DATADIR@/dbspace/.@PROJECT_NAME@.db ] +then + sqlite3 @DATADIR@/dbspace/.@PROJECT_NAME@.db 'PRAGMA journal_mode = PERSIST; + create table if not exists badge_data ( + pkgname TEXT NOT NULL, + writable_pkgs TEXT, + badge INTEGER default 0, + rowid INTEGER PRIMARY KEY AUTOINCREMENT, + UNIQUE (pkgname) + ); + ' +fi + +if [ ${USER} = "root" ] +then + chown root:5000 @DATADIR@/dbspace/.@PROJECT_NAME@.db + chown root:5000 @DATADIR@/dbspace/.@PROJECT_NAME@.db-journal +fi +chmod 660 @DATADIR@/dbspace/.@PROJECT_NAME@.db +chmod 660 @DATADIR@/dbspace/.@PROJECT_NAME@.db-journal diff --git a/debian/rules b/debian/rules new file mode 100755 index 0000000..68ad4f3 --- /dev/null +++ b/debian/rules @@ -0,0 +1,116 @@ +#!/usr/bin/make -f +# -*- makefile -*- +# Sample debian/rules that uses debhelper. +# This file was originally written by Joey Hess and Craig Small. +# As a special exception, when this file is copied by dh-make into a +# dh-make output file, you may use that output file without restriction. +# This special exception was added by Craig Small in version 0.37 of dh-make. + +# Uncomment this to turn on verbose mode. +#export DH_VERBOSE=1 + +CFLAGS ?= -Wall -Werror -Winline +LDFLAGS ?= +PREFIX ?= /usr +DATADIR ?= /opt +PROJECT_NAME ?= badge + +BUILDDIR ?= $(CURDIR)/cmake-tmp + +ifneq (,$(findstring noopt,$(DEB_BUILD_OPTIONS))) + CFLAGS += -O0 +else + CFLAGS += -O2 +endif + +LDFLAGS += -Wl,--rpath=$(PREFIX)/lib -Wl,--as-needed -lm + +configure: configure-stamp +configure-stamp: + dh_testdir + # Add here commands to configure the package. + mkdir -p $(BUILDDIR) && cd $(BUILDDIR) && CFLAGS="$(CFLAGS)" LDFLAGS="$(LDFLAGS)" cmake .. -DCMAKE_INSTALL_PREFIX=$(PREFIX) + + touch configure-stamp + +build: build-stamp + +build-stamp: configure-stamp + dh_testdir + + # Add here commands to compile the package. + cd $(BUILDDIR) && $(MAKE) + #docbook-to-man debian/wavplayer.sgml > wavplayer.1 + + for f in `find $(CURDIR)/debian/ -name "*.in"`; do \ + cat $$f > $${f%.in}; \ + sed -i -e "s#@PREFIX@#$(PREFIX)#g" $${f%.in}; \ + sed -i -e "s#@PROJECT_NAME@#$(PROJECT_NAME)#g" $${f%.in}; \ + sed -i -e "s#@DATADIR@#$(DATADIR)#g" $${f%.in}; \ + done + + + touch $@ + +clean: + dh_testdir + dh_testroot + rm -f build-stamp configure-stamp + + # Add here commands to clean up after the build process. + rm -rf $(BUILDDIR) + #rm -rf CMakeCache.txt CMakeFiles cmake_install.cmake Makefile install_manifest.txt + + for f in `find $(CURDIR)/debian/ -name "*.in"`; do \ + rm -f $${f%.in}; \ + done + + dh_clean + +install: build + dh_testdir + dh_testroot + dh_clean -k + dh_installdirs + + # Add here commands to install the package into debian/wavplayer. + cd $(BUILDDIR) && $(MAKE) DESTDIR=$(CURDIR)/debian/tmp install + + +# Build architecture-independent files here. +binary-indep: build install +# We have nothing to do by default. + +# Build architecture-dependent files here. +binary-arch: build install + dh_testdir + dh_testroot + dh_installchangelogs + dh_installdocs + dh_installexamples + dh_install --sourcedir=debian/tmp +# dh_installmenu +# dh_installdebconf +# dh_installlogrotate +# dh_installemacsen +# dh_installpam +# dh_installmime +# dh_python +# dh_installinit +# dh_installcron +# dh_installinfo + dh_installman + dh_link + dh_strip --dbg-package=libbadge-dbg + dh_compress + dh_fixperms +# dh_perl + dh_makeshlibs + dh_installdeb + dh_shlibdeps + dh_gencontrol + dh_md5sums + dh_builddeb + +binary: binary-indep binary-arch +.PHONY: build clean binary-indep binary-arch binary install configure diff --git a/doc/badge_doc.h b/doc/badge_doc.h new file mode 100755 index 0000000..31fb372 --- /dev/null +++ b/doc/badge_doc.h @@ -0,0 +1,44 @@ +/* + * libbadge + * + * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved. + * + * Contact: Youngjoo Park <yjoo93.park@samsung.com>, + * Seungtaek Chung <seungtaek.chung@samsung.com>, Youngsub Ko <ys4610.ko@samsung.com> + * + * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * 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. + * + */ + +/** + * + * @ingroup BADGE_LIBRARY + * @defgroup BADGE_MODULE badge APIs + * @brief Badge APIs + * + * @section BADGE_MODULE_HEADER Required Header + * \#include <badge.h> + * @section BADGE_MODULE_OVERVIEW Overview + * It provides functions for creating and inserting and updating badge. + * + * @ingroup BADGE_LIBRARY + * @defgroup BADGE_TYPE badge type + * @brief Type for badge APIs + * + * @section BADGE_TYPE_MODULE_HEADER Required Header + * \#include <badge.h> + * \#include <badge_error.h> + * @section BADGE_TYPE_MODULE_OVERVIEW Overview + * Type defines and enumerations for Badge APIs + * + */ diff --git a/doc/doxygen.conf b/doc/doxygen.conf new file mode 100755 index 0000000..6005bb2 --- /dev/null +++ b/doc/doxygen.conf @@ -0,0 +1,1781 @@ +# Doxyfile 1.7.6.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" "). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or sequence of words) that should +# identify the project. Note that if you do not use Doxywizard you need +# to put quotes around the project name if it contains spaces. + +PROJECT_NAME = "My Project" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer +# a quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify an logo or icon that is +# included in the documentation. The maximum height of the logo should not +# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# Doxygen will copy the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful if your file system +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding +# "class=itcl::class" will allow you to use the command class in the +# itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given extension. +# Doxygen has a built-in mapping, but you can override or extend it using this +# tag. The format is ext=language, where ext is a file extension, and language +# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, +# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions +# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also makes the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and +# unions are shown inside the group in which they are included (e.g. using +# @ingroup) instead of on a separate page (for HTML and Man pages) or +# section (for LaTeX and RTF). + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and +# unions with only public data fields will be shown inline in the documentation +# of the scope in which they are defined (i.e. file, namespace, or group +# documentation), provided this scope is documented. If set to NO (the default), +# structs, classes, and unions are shown on a separate page (for HTML and Man +# pages) or section (for LaTeX and RTF). + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penalty. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will roughly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +SYMBOL_CACHE_SIZE = 0 + +# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be +# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given +# their name and scope. Since this can be an expensive process and often the +# same symbol appear multiple times in the code, doxygen keeps a cache of +# pre-resolved symbols. If the cache is too small doxygen will become slower. +# If the cache is too large, memory is wasted. The cache size is given by this +# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespaces are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +# do proper type resolution of all parameters of a function it will reject a +# match between the prototype and the implementation of a member function even +# if there is only one candidate or it is obvious which candidate to choose +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +# will still accept a match between prototype and implementation in such cases. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or macro consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and macros in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = NO + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. +# This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command <command> <input-file>, where <command> is the value of +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. The create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. +# You can optionally specify a file name after the option, if omitted +# DoxygenLayout.xml will be used as the name of the layout file. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files +# containing the references data. This must be a list of .bib files. The +# .bib extension is automatically appended if omitted. Using this command +# requires the bibtex tool to be installed. See also +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this +# feature you need bibtex and perl available in the search path. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# The WARN_NO_PARAMDOC option can be enabled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = ./badge_doc.h ../include/badge_db.h ../include/badge_error.h ../include/badge.h ../include/badge_setting.h + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# *.f90 *.f *.for *.vhd *.vhdl + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command <filter> <input-file>, where <filter> +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. +# If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. +# Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. +# The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty or if +# non of the patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) +# and it is also possible to disable source filtering for a specific pattern +# using *.ext= (so without naming a filter). This option only has effect when +# FILTER_SOURCE_FILES is enabled. + +FILTER_SOURCE_PATTERNS = + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. +# Otherwise they will link to the documentation. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = YES + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. Note that when using a custom header you are responsible +# for the proper inclusion of any scripts and style sheets that doxygen +# needs, which is dependent on the configuration options used. +# It is advised to generate a default header using "doxygen -w html +# header.html footer.html stylesheet.css YourConfigFile" and then modify +# that header. Note that the header is subject to change so you typically +# have to redo this when upgrading to a newer version of doxygen or when +# changing the value of configuration settings such as GENERATE_TREEVIEW! + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# style sheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that +# the files will be copied as-is; there are no commands or markers available. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the style sheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = YES + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated +# that can be used as input for Qt's qhelpgenerator to generate a +# Qt Compressed Help (.qch) of the generated HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see +# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> +# Qt Help Project / Custom Filters</a>. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's +# filter section matches. +# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> +# Qt Help Project / Filter Attributes</a>. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) +# at top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. Since the tabs have the same information as the +# navigation tree you can set this option to NO if you already set +# GENERATE_TREEVIEW to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to YES, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. +# Since the tree basically has the same information as the tab index you +# could consider to set DISABLE_INDEX to NO when enabling this option. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values +# (range [0,1..20]) that doxygen will group on one line in the generated HTML +# documentation. Note that a value of 0 will completely suppress the enum +# values from appearing in the overview section. + +ENUM_VALUES_PER_LINE = 4 + +# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list. + +USE_INLINE_TREES = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax +# (see http://www.mathjax.org) which uses client side Javascript for the +# rendering instead of using prerendered bitmaps. Use this if you do not +# have LaTeX installed or if you want to formulas look prettier in the HTML +# output. When enabled you also need to install MathJax separately and +# configure the path to it using the MATHJAX_RELPATH option. + +USE_MATHJAX = NO + +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the +# mathjax.org site, so you can quickly see the result without installing +# MathJax, but it is strongly recommended to install a local copy of MathJax +# before deployment. + +MATHJAX_RELPATH = http://www.mathjax.org/mathjax + +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +# names that should be enabled during MathJax rendering. + +MATHJAX_EXTENSIONS = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box +# for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvantages are that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = YES + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! + +LATEX_FOOTER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See +# http://en.wikipedia.org/wiki/BibTeX for more info. + +LATEX_BIB_STYLE = plain + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load style sheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. +# This is useful +# if you want to understand what is going on. +# On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# pointed to by INCLUDE_PATH will be searched when a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition that +# overrules the definition found in the source code. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these will confuse the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option also works with HAVE_DOT disabled, but it is recommended to +# install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will use the Helvetica font for all dot files that +# doxygen generates. When you want a differently looking font you can specify +# the font name using DOT_FONTNAME. You need to make sure dot is able to find +# the font, which can be done by putting it in a standard location or by setting +# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. + +DOT_FONTNAME = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the Helvetica font. +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +# set the path where dot can find it. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will generate a graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are svg, png, jpg, or gif. +# If left blank png will be used. If you choose svg you need to set +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible in IE 9+ (other browsers do not have this requirement). + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# Note that this requires a modern browser other than Internet Explorer. +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible. Older versions of IE do not have SVG support. + +INTERACTIVE_SVG = NO + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). + +MSCFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = YES + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES diff --git a/include/badge.h b/include/badge.h new file mode 100755 index 0000000..347dcad --- /dev/null +++ b/include/badge.h @@ -0,0 +1,309 @@ +/* + * libbadge + * + * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved. + * + * Contact: Youngjoo Park <yjoo93.park@samsung.com>, + * Seungtaek Chung <seungtaek.chung@samsung.com>, Youngsub Ko <ys4610.ko@samsung.com> + * + * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * 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 __BADGE_DEF_H__ +#define __BADGE_DEF_H__ + +#include <stdbool.h> +#include <badge_error.h> + +#ifdef __cplusplus +extern "C" { +#endif /* __cplusplus */ + +/** + * @file badge.h + * @brief This file contains the badge APIs + */ + +/** + * @addtogroup BADGE_TYPE + * @{ + */ + +/** + * @brief Enumeration for Badge action + */ +enum _badge_action { + BADGE_ACTION_CREATE = 0, + BADGE_ACTION_REMOVE, + BADGE_ACTION_UPDATE, + BADGE_ACTION_CHANGED_DISPLAY, + BADGE_ACTION_SERVICE_READY, +}; + + +/** + * @brief Called to retrieve the badge existed. + * @param[in] pkgname The name of package + * @param[in] count The count of badge + * @param[in] user_data The user data passed from the foreach function + * @pre badge_foreach_existed() will invoke this callback. + * @see badge_foreach_existed() + */ +typedef void (*badge_cb)(const char *pkgname, unsigned int count, void *data); + + +/** + * @brief Called when badge information is changed. + * @param[in] action The type of changing + * @param[in] pkgname The name of package + * @param[in] count The count of badge + * @param[in] user_data The user data passed from the callback register function + * @pre badge_register_changed_cb() will invoke this callback. + * @see badge_unregister_changed_cb() + */ +typedef void (*badge_change_cb)(unsigned int action, const char *pkgname, + unsigned int count, void *data); + +/** + * @} + */ + +/** + * @addtogroup BADGE_MODULE + * @{ + */ + +/** + * @brief This function creates badge for designated package. + * @details Creates new badge to display. + * @param[in] pkgname The name of designated package + * @param[in] writable_pkg The name of package which is authorized to change badge + * @return #BADGE_ERROR_NONE if success, other value if failure + * @see #badge_error_e + * @par Sample code: + * @code +#include <badge.h> +... +{ + badge_error_e err = BADGE_ERROR_NONE; + + err = badge_create("org.tizen.sms", "org.tizen.sms2"); + if(err != BADGE_ERROR_NONE) { + return; + } + +} + * @endcode + */ +badge_error_e badge_create(const char *pkgname, const char *writable_pkg); + + +/** + * @brief This function removes badge for designated package. + * @param[in] pkgname The name of designated package + * @return #BADGE_ERROR_NONE if success, other value if failure + * @see #badge_error_e + * @par Sample code: + * @code +#include <badge.h> +... +{ + badge_error_e err = BADGE_ERROR_NONE; + + err = badge_remove("org.tizen.sms"); + if(err != BADGE_ERROR_NONE) { + return; + } + +} + * @endcode + */ +badge_error_e badge_remove(const char *pkgname); + +/** + * @brief This function sets badge count for designated package. + * @param[in] pkgname The name of designated package + * @param[in] count The count of badge + * @return #BADGE_ERROR_NONE if success, other value if failure + * @see #badge_error_e + * @see badge_create() + * @par Sample code: + * @code +#include <badge.h> +... +{ + badge_error_e err = BADGE_ERROR_NONE; + + err = badge_set_count("org.tizen.sms", 1); + if(err != BADGE_ERROR_NONE) { + return; + } + +} + * @endcode + */ +badge_error_e badge_set_count(const char *pkgname, unsigned int count); + +/** + * @brief This function gets badge count for designated package. + * @param[in] pkgname The name of designated package + * @param[out] count The count of badge + * @return #BADGE_ERROR_NONE if success, other value if failure + * @see #badge_error_e + * @see badge_create() + * @see badge_set_count() + * @par Sample code: + * @code +#include <badge.h> +... +{ + badge_error_e err = BADGE_ERROR_NONE; + + err = badge_get_count("org.tizen.sms", 1); + if(err != BADGE_ERROR_NONE) { + return; + } + +} + * @endcode + */ +badge_error_e badge_get_count(const char *pkgname, unsigned int *count); + +/** + * @brief This function sets displaying option for designated package. + * @param[in] pkgname The name of designated package + * @param[in] is_display The displaying option, 1 = display 0 = not display + * @return #BADGE_ERROR_NONE if success, other value if failure + * @see #badge_error_e + * @see badge_create() + * @par Sample code: + * @code +#include <badge.h> +... +{ + badge_error_e err = BADGE_ERROR_NONE; + + err = badge_set_display("org.tizen.sms", 1); + if(err != BADGE_ERROR_NONE) { + return; + } + +} + * @endcode + */ +badge_error_e badge_set_display(const char *pkgname, unsigned int is_display); + +/** + * @brief This function gets displaying option for designated package. + * @param[in] pkgname The name of designated package + * @param[out] is_display The displaying option, 1 = display 0 = not display + * @return #BADGE_ERROR_NONE if success, other value if failure + * @see #badge_error_e + * @see badge_create() + * @see badge_set_count() + * @par Sample code: + * @code +#include <badge.h> +... +{ + int is_display = 0; + badge_error_e err = BADGE_ERROR_NONE; + + err = badge_get_display("org.tizen.sms", &is_display); + if(err != BADGE_ERROR_NONE) { + return; + } + +} + * @endcode + */ +badge_error_e badge_get_display(const char *pkgname, unsigned int *is_display); + +/** + * @brief This function tests badge for designated package is existed or not. + * @param[in] pkgname The name of designated package + * @param[out] existing The bool value of badge existing status + * @return #BADGE_ERROR_NONE if success, other value if failure + * @see #badge_error_e + * @see badge_create() + * @see badge_remove() + * @par Sample code: + * @code +#include <badge.h> +... +{ + badge_error_e err = BADGE_ERROR_NONE; + bool exist; + + err = badge_is_existing("org.tizen.sms", &exist); + if(err != BADGE_ERROR_NONE) { + return; + } + +} + * @endcode + */ +badge_error_e badge_is_existing(const char *pkgname, bool *existing); + +/** + * @brief This function retrieves all badges which are existed. + * @param[in] callback The callback function + * @param[in] data The user data to be passed to the callback function + * @return #BADGE_ERROR_NONE if success, other value if failure + * @see #badge_error_e + * @see badge_get_count() + * @see badge_is_existing() + */ +badge_error_e badge_foreach_existed(badge_cb callback, void *data); + +/** + * @brief This function registers callback function to receive badge changed event. + * @param[in] callback The callback function + * @param[in] data The user data to be passed to the callback function + * @return #BADGE_ERROR_NONE if success, other value if failure + * @see #badge_error_e + * @see badge_create() + * @see badge_remove() + * @see badge_set_count() + */ +badge_error_e badge_register_changed_cb(badge_change_cb callback, void *data); + +/** + * @brief This function unregisters callback function to receive badge changed event. + * @param[in] callback The callback function + * @return #BADGE_ERROR_NONE if success, other value if failure + * @see #badge_error_e + * @see badge_register_changed_cb() + */ +badge_error_e badge_unregister_changed_cb(badge_change_cb callback); + +/** + * @} + */ + +int badge_is_service_ready(void); + +badge_error_e badge_add_deffered_task( + void (*deffered_task_cb)(void *data), void *user_data); + +badge_error_e badge_del_deffered_task( + void (*deffered_task_cb)(void *data)); + +#ifdef __cplusplus +} +#endif /* __cplusplus */ + +#endif /* __BADGE_DEF_H__ */ + + diff --git a/include/badge_db.h b/include/badge_db.h new file mode 100755 index 0000000..1d490c5 --- /dev/null +++ b/include/badge_db.h @@ -0,0 +1,46 @@ +/* + * libbadge + * + * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved. + * + * Contact: Youngjoo Park <yjoo93.park@samsung.com>, + * Seungtaek Chung <seungtaek.chung@samsung.com>, Youngsub Ko <ys4610.ko@samsung.com> + * + * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * 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 __BADGE_DB_DEF_H__ +#define __BADGE_DB_DEF_H__ + +#include <stdbool.h> +#include <sqlite3.h> +#include <badge_error.h> + +#ifdef __cplusplus +extern "C" { +#endif + +badge_error_e badge_db_insert(const char *pkgname, const char *writable_pkg, const char *caller); +badge_error_e badge_db_delete(const char *pkgname, const char *caller_pkg); +badge_error_e badge_db_set_count(const char *pkgname, const char *caller_pkg, int count); +badge_error_e badge_db_set_display_option(const char *pkgname, const char *caller_pkg, int is_display); +badge_error_e badge_db_exec(sqlite3 * db, const char *query, int *num_changes); + +#ifdef __cplusplus + } +#endif + +#endif /* __BADGE_DB_DEF_H__ */ + diff --git a/include/badge_error.h b/include/badge_error.h new file mode 100755 index 0000000..89d1abb --- /dev/null +++ b/include/badge_error.h @@ -0,0 +1,66 @@ +/* + * libbadge + * + * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved. + * + * Contact: Youngjoo Park <yjoo93.park@samsung.com>, + * Seungtaek Chung <seungtaek.chung@samsung.com>, Youngsub Ko <ys4610.ko@samsung.com> + * + * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * 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 __BADGE_ERROR_DEF_H__ +#define __BADGE_ERROR_DEF_H__ + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @file badge_error.h + * @brief This file contains the badge APIs + */ + +/** + * @addtogroup BADGE_TYPE + * @{ + */ + +/** + * @breief Enumeration for Badge error + */ +typedef enum _badge_error_e { + BADGE_ERROR_NONE = 0, /**< Success */ + BADGE_ERROR_INVALID_DATA = -1, /**< Invalid parameter */ + BADGE_ERROR_NO_MEMORY = -2, /**< No memory */ + BADGE_ERROR_FROM_DB = -3, /**< Error from DB */ + BADGE_ERROR_ALREADY_EXIST = -4, /**< Already exist */ + BADGE_ERROR_FROM_DBUS = -5, /**< Error from DBus */ + BADGE_ERROR_NOT_EXIST = -6, /**< Not exist */ + BADGE_ERROR_PERMISSION_DENIED = -7, /**< Permission denied */ + BADGE_ERROR_IO = -8, /**< Error from I/O */ + BADGE_ERROR_SERVICE_NOT_READY = -9, /**< Error service not ready */ +} badge_error_e; + +/** + * @} + */ + +#ifdef __cplusplus + } +#endif + +#endif /* __BADGE_ERROR_DEF_H__ */ + diff --git a/include/badge_internal.h b/include/badge_internal.h new file mode 100755 index 0000000..d3b6681 --- /dev/null +++ b/include/badge_internal.h @@ -0,0 +1,76 @@ +/* + * libbadge + * + * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved. + * + * Contact: Youngjoo Park <yjoo93.park@samsung.com>, + * Seungtaek Chung <seungtaek.chung@samsung.com>, Youngsub Ko <ys4610.ko@samsung.com> + * + * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * 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 __BADGE_INTERNAL_DEF_H__ +#define __BADGE_INTERNAL_DEF_H__ + +#include <stdbool.h> +#include <stdarg.h> + +#include "badge_error.h" +#include "badge.h" + +#ifndef EXPORT_API +#define EXPORT_API __attribute__ ((visibility("default"))) +#endif + +typedef struct _badge_h badge_h; + +char *_badge_get_pkgname_by_pid(void); + +badge_error_e _badge_is_existing(const char *pkgname, bool *existing); + +badge_error_e _badge_foreach_existed(badge_cb callback, void *data); + +badge_error_e _badge_insert(badge_h *badge); + +badge_error_e _badge_remove(const char *caller, const char *pkgname); + +badge_error_e _badget_set_count(const char *caller, const char *pkgname, + unsigned int count); + +badge_error_e _badget_get_count(const char *pkgname, unsigned int *count); + +badge_error_e _badget_set_display(const char *pkgname, + unsigned int is_display); + +badge_error_e _badget_get_display(const char *pkgname, unsigned int *is_display); + +badge_error_e _badge_register_changed_cb(badge_change_cb callback, void *data); + +badge_error_e _badge_unregister_changed_cb(badge_change_cb callback); + +badge_error_e _badge_free(badge_h *badge); + +badge_h *_badge_new(const char *pkgname, const char *writable_pkgs, + badge_error_e *err); + +char *_badge_pkgs_new(badge_error_e *err, const char *pkg1, ...); + +char *_badge_pkgs_new_valist(badge_error_e *err, + const char *pkg1, va_list args); + +void badge_changed_cb_call(unsigned int action, const char *pkgname, + unsigned int count); + +#endif /* __BADGE_INTERNAL_DEF_H__ */ + diff --git a/include/badge_ipc.h b/include/badge_ipc.h new file mode 100755 index 0000000..3574402 --- /dev/null +++ b/include/badge_ipc.h @@ -0,0 +1,54 @@ +/* + * libbadge + * + * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved. + * + * Contact: Youngjoo Park <yjoo93.park@samsung.com>, + * Seungtaek Chung <seungtaek.chung@samsung.com>, Youngsub Ko <ys4610.ko@samsung.com> + * + * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * 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 __BADGE_IPC_H__ +#define __BADGE_IPC_H__ + +#include <badge.h> + +#define BADGE_ADDR "/tmp/.badge.service" + +#ifdef __cplusplus +extern "C" { +#endif + +struct packet; + +badge_error_e badge_ipc_monitor_init(void); +badge_error_e badge_ipc_monitor_fini(void); + +badge_error_e badge_ipc_request_insert(const char *pkgname, const char *writable_pkg, const char *caller); +badge_error_e badge_ipc_request_delete(const char *pkgname, const char *caller); +badge_error_e badge_ipc_request_set_count(const char *pkgname, const char *caller, int count); +badge_error_e badge_ipc_request_set_display(const char *pkgname, const char *caller, int display_option); + +int badge_ipc_is_master_ready(void); +badge_error_e badge_ipc_add_deffered_task(void (*deffered_task_cb)(void *data), void *user_data); +badge_error_e badge_ipc_del_deffered_task(void (*deffered_task_cb)(void *data)); + +badge_error_e badge_ipc_setting_property_set(const char *pkgname, const char *property, const char *value); +badge_error_e badge_ipc_setting_property_get(const char *pkgname, const char *property, char **value); + +#ifdef __cplusplus +} +#endif +#endif diff --git a/include/badge_log.h b/include/badge_log.h new file mode 100755 index 0000000..58a3d8c --- /dev/null +++ b/include/badge_log.h @@ -0,0 +1,81 @@ +/* + * libbadge + * + * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved. + * + * Contact: Youngjoo Park <yjoo93.park@samsung.com>, + * Seungtaek Chung <seungtaek.chung@samsung.com>, Youngsub Ko <ys4610.ko@samsung.com> + * + * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * 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 __BADGE_LOG_DEF_H__ +#define __BADGE_LOG_DEF_H__ + +#ifdef BADGE_USE_DLOG + +#include <dlog.h> +#ifdef LOG_TAG +#undef LOG_TAG +#endif +#define LOG_TAG "BADGE" + +#define DBG(fmt , args...) \ + do { \ + SECURE_LOGD("[%s : %d] "fmt"\n", __func__, __LINE__, ##args); \ + } while (0) + +#define INFO(fmt , args...) \ + do { \ + SECURE_LOGI("[%s : %d] "fmt"\n", __func__, __LINE__, ##args); \ + } while (0) + +#define WARN(fmt , args...) \ + do { \ + SECURE_LOGW("[%s : %d] "fmt"\n", __func__, __LINE__, ##args); \ + } while (0) + +#define ERR(fmt , args...) \ + do { \ + SECURE_LOGE("[%s : %d] "fmt"\n", __func__, __LINE__, ##args); \ + } while (0) + +#else /* BADGE_USE_DLOG */ + +#include <stdio.h> + +#define DBG(fmt , args...) \ + do { \ + printf("[D][%s : %d] "fmt"\n", __func__, __LINE__, ##args); \ + } while (0) + +#define INFO(fmt , args...) \ + do { \ + printf("[I][%s : %d] "fmt"\n", __func__, __LINE__, ##args); \ + } while (0) + +#define WARN(fmt , args...) \ + do { \ + printf("[W][%s : %d] "fmt"\n", __func__, __LINE__, ##args); \ + } while (0) + +#define ERR(fmt , args...) \ + do { \ + printf("[E][%s : %d] "fmt"\n", __func__, __LINE__, ##args); \ + } while (0) + +#endif /* BADGE_USE_DLOG */ + +#endif /* __BADGE_LOG_DEF_H__ */ diff --git a/include/badge_setting.h b/include/badge_setting.h new file mode 100755 index 0000000..6934dcf --- /dev/null +++ b/include/badge_setting.h @@ -0,0 +1,39 @@ +/* + * libbadge + * + * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved. + * + * Contact: Youngjoo Park <yjoo93.park@samsung.com>, + * Seungtaek Chung <seungtaek.chung@samsung.com>, Youngsub Ko <ys4610.ko@samsung.com> + * + * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * 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 __BADGE_SETTING_H__ +#define __BADGE_SETTING_H__ + +#include <stdbool.h> +#include <badge_error.h> + +#ifdef __cplusplus +extern "C" { +#endif + +badge_error_e badge_setting_property_set(const char *pkgname, const char *property, const char *value); +badge_error_e badge_setting_property_get(const char *pkgname, const char *property, char **value); + +#ifdef __cplusplus +} +#endif +#endif diff --git a/include/badge_setting_service.h b/include/badge_setting_service.h new file mode 100755 index 0000000..9b452a7 --- /dev/null +++ b/include/badge_setting_service.h @@ -0,0 +1,39 @@ +/* + * libbadge + * + * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved. + * + * Contact: Youngjoo Park <yjoo93.park@samsung.com>, + * Seungtaek Chung <seungtaek.chung@samsung.com>, Youngsub Ko <ys4610.ko@samsung.com> + * + * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * 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 __BADGE_SETTING_SERVICE_H__ +#define __BADGE_SETTING_SERVICE_H__ + +#include <stdbool.h> +#include <badge_error.h> + +#ifdef __cplusplus +extern "C" { +#endif + +badge_error_e badge_setting_db_set(const char *pkgname, const char *property, const char *value); +badge_error_e badge_setting_db_get(const char *pkgname, const char *property, char **value); + +#ifdef __cplusplus +} +#endif +#endif diff --git a/packaging/badge.spec b/packaging/badge.spec new file mode 100755 index 0000000..3a88926 --- /dev/null +++ b/packaging/badge.spec @@ -0,0 +1,117 @@ +%define DBDIR "/opt/dbspace" +Name: badge +Summary: badge library +Version: 0.0.15 +Release: 1 +VCS: magnolia/framework/appfw/badge#badge_0.0.2-2-34-g7d493a8a797f0022faafaa25561d2e85a2bde6bf +Group: TBD +License: Apache-2.0 +Source0: %{name}-%{version}.tar.gz +BuildRequires: pkgconfig(aul) +BuildRequires: pkgconfig(dbus-1) +BuildRequires: pkgconfig(dbus-glib-1) +BuildRequires: pkgconfig(dlog) +BuildRequires: pkgconfig(vconf) +BuildRequires: pkgconfig(com-core) +BuildRequires: cmake +Requires(post): /sbin/ldconfig +requires(postun): /sbin/ldconfig +%description +Client/Server library for updating badge information + +%prep +%setup -q + +%package devel +Summary: Badge library (devel) +Group: Development/Libraries +Requires: %{name} = %{version}-%{release} + +%description devel +Development files needed to build software that needs to system a system badge. + +%package service-devel +Summary: Badge library (service-devel) +Group: Development/Libraries +Requires: %{name} = %{version}-%{release} + +%description service-devel +Development files needed to build badge service + +%build +%if 0%{?tizen_build_binary_release_type_eng} +export CFLAGS="$CFLAGS -DTIZEN_ENGINEER_MODE" +export CXXFLAGS="$CXXFLAGS -DTIZEN_ENGINEER_MODE" +export FFLAGS="$FFLAGS -DTIZEN_ENGINEER_MODE" +%endif +%if 0%{?sec_build_binary_debug_enable} +export CFLAGS="$CFLAGS -DTIZEN_DEBUG_ENABLE" +export CXXFLAGS="$CXXFLAGS -DTIZEN_DEBUG_ENABLE" +export FFLAGS="$FFLAGS -DTIZEN_DEBUG_ENABLE" +%endif +export LDFLAGS+="-Wl,--rpath=%{_prefix}/lib -Wl,--as-needed" +LDFLAGS="$LDFLAGS" cmake . -DCMAKE_INSTALL_PREFIX=%{_prefix} +make %{?jobs:-j%jobs} + +%install +%make_install + +mkdir -p %{buildroot}/usr/share/license +cp -f LICENSE %{buildroot}/usr/share/license/%{name} + + +%post +/sbin/ldconfig + +if [ ! -d %{DBDIR} ] +then + mkdir -p %{DBDIR} +fi + +if [ ! -f %{DBDIR}/.%{name}.db ] +then + sqlite3 %{DBDIR}/.%{name}.db 'PRAGMA journal_mode = PERSIST; + create table if not exists badge_data ( + pkgname TEXT NOT NULL, + writable_pkgs TEXT, + badge INTEGER default 0, + rowid INTEGER PRIMARY KEY AUTOINCREMENT, + UNIQUE (pkgname) + ); + create table if not exists badge_option ( + pkgname TEXT NOT NULL, + display INTEGER default 1, + UNIQUE (pkgname) + ); + ' +fi + +chown :5000 %{DBDIR}/.%{name}.db +chown :5000 %{DBDIR}/.%{name}.db-journal +chmod 640 %{DBDIR}/.%{name}.db +chmod 640 %{DBDIR}/.%{name}.db-journal +if [ -f /usr/lib/rpm-plugins/msm.so ] +then + chsmack -a 'badge::db' %{DBDIR}/.%{name}.db* +fi + +%postun -p /sbin/ldconfig + +%files +%manifest badge.manifest +%defattr(-,root,root,-) +%{_libdir}/libbadge.so* +/usr/share/license/%{name} + +%files devel +%defattr(-,root,root,-) +%{_includedir}/badge/badge.h +%{_includedir}/badge/badge_error.h +%{_includedir}/badge/badge_setting.h +%{_libdir}/pkgconfig/%{name}.pc + +%files service-devel +%defattr(-,root,root,-) +%{_includedir}/badge/service/badge_db.h +%{_includedir}/badge/service/badge_setting_service.h +%{_libdir}/pkgconfig/badge-service.pc diff --git a/src/badge.c b/src/badge.c new file mode 100755 index 0000000..7af551a --- /dev/null +++ b/src/badge.c @@ -0,0 +1,183 @@ +/* + * libbadge + * + * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved. + * + * Contact: Youngjoo Park <yjoo93.park@samsung.com>, + * Seungtaek Chung <seungtaek.chung@samsung.com>, Youngsub Ko <ys4610.ko@samsung.com> + * + * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * 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. + * + */ + +#include <stdlib.h> +#include <stdarg.h> + +#include "badge.h" +#include "badge_log.h" +#include "badge_error.h" +#include "badge_internal.h" +#include "badge_ipc.h" + +EXPORT_API +badge_error_e badge_create(const char *pkgname, const char *writable_pkg) +{ + char *caller = NULL; + badge_error_e err = BADGE_ERROR_NONE; + + if (pkgname == NULL) { + return BADGE_ERROR_INVALID_DATA; + } + + caller = _badge_get_pkgname_by_pid(); + if (!caller) { + ERR("fail to get caller pkgname"); + return BADGE_ERROR_PERMISSION_DENIED; + } + + err = badge_ipc_request_insert(pkgname, writable_pkg, caller); + + free(caller); + return err; +} + +EXPORT_API +badge_error_e badge_remove(const char *pkgname) +{ + char *caller = NULL; + badge_error_e result = BADGE_ERROR_NONE; + + if (pkgname == NULL) { + return BADGE_ERROR_INVALID_DATA; + } + + caller = _badge_get_pkgname_by_pid(); + if (!caller) { + ERR("fail to get caller pkgname"); + return BADGE_ERROR_PERMISSION_DENIED; + } + + result = badge_ipc_request_delete(pkgname, caller); + + free(caller); + return result; +} + +EXPORT_API +badge_error_e badge_is_existing(const char *pkgname, bool *existing) +{ + return _badge_is_existing(pkgname, existing); +} + + +EXPORT_API +badge_error_e badge_foreach_existed(badge_cb callback, void *data) +{ + return _badge_foreach_existed(callback, data); +} + +EXPORT_API +badge_error_e badge_set_count(const char *pkgname, unsigned int count) +{ + char *caller = NULL; + badge_error_e result = BADGE_ERROR_NONE; + + if (pkgname == NULL) { + return BADGE_ERROR_INVALID_DATA; + } + + caller = _badge_get_pkgname_by_pid(); + if (!caller) { + ERR("fail to get caller pkgname"); + return BADGE_ERROR_PERMISSION_DENIED; + } + + result = badge_ipc_request_set_count(pkgname, caller, count); + + free(caller); + return result; +} + +EXPORT_API +badge_error_e badge_get_count(const char *pkgname, unsigned int *count) +{ + return _badget_get_count(pkgname, count); +} + +EXPORT_API +badge_error_e badge_set_display(const char *pkgname, unsigned int is_display) +{ + char *caller = NULL; + badge_error_e result = BADGE_ERROR_NONE; + + if (pkgname == NULL) { + return BADGE_ERROR_INVALID_DATA; + } + + caller = _badge_get_pkgname_by_pid(); + if (!caller) { + ERR("fail to get caller pkgname"); + return BADGE_ERROR_PERMISSION_DENIED; + } + + result = badge_ipc_request_set_display(pkgname, caller, is_display); + + free(caller); + return result; +} + +EXPORT_API +badge_error_e badge_get_display(const char *pkgname, unsigned int *is_display) +{ + return _badget_get_display(pkgname, is_display); +} + +EXPORT_API +badge_error_e badge_register_changed_cb(badge_change_cb callback, void *data) +{ + if (callback == NULL) { + return BADGE_ERROR_INVALID_DATA; + } + + return _badge_register_changed_cb(callback, data); +} + +EXPORT_API +badge_error_e badge_unregister_changed_cb(badge_change_cb callback) +{ + if (callback == NULL) { + return BADGE_ERROR_INVALID_DATA; + } + + return _badge_unregister_changed_cb(callback); +} + +EXPORT_API +int badge_is_service_ready(void) +{ + return badge_ipc_is_master_ready(); +} + +EXPORT_API +badge_error_e badge_add_deffered_task( + void (*deffered_task_cb)(void *data), void *user_data) +{ + return badge_ipc_add_deffered_task(deffered_task_cb, user_data); +} + +EXPORT_API +badge_error_e badge_del_deffered_task( + void (*deffered_task_cb)(void *data)) +{ + return badge_ipc_del_deffered_task(deffered_task_cb); +} diff --git a/src/badge_db.c b/src/badge_db.c new file mode 100755 index 0000000..e95e9c6 --- /dev/null +++ b/src/badge_db.c @@ -0,0 +1,140 @@ +/* + * libbadge + * + * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved. + * + * Contact: Youngjoo Park <yjoo93.park@samsung.com>, + * Seungtaek Chung <seungtaek.chung@samsung.com>, Youngsub Ko <ys4610.ko@samsung.com> + * + * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * 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. + * + */ + +#include <stdlib.h> +#include <stdarg.h> +#include <sqlite3.h> + +#include "badge.h" +#include "badge_log.h" +#include "badge_error.h" +#include "badge_internal.h" + +EXPORT_API +badge_error_e badge_db_insert(const char *pkgname, const char *writable_pkg, const char *caller) +{ + badge_error_e err = BADGE_ERROR_NONE; + badge_h *badge = NULL; + char *pkgs = NULL; + + if (!pkgname) { + WARN("package name is NULL"); + return BADGE_ERROR_INVALID_DATA; + } + + pkgs = _badge_pkgs_new(&err, writable_pkg, caller, NULL); + if (!pkgs) { + ERR("fail to _badge_pkgs_new : %d", err); + return err; + } + + INFO("pkgs : %s", pkgs); + + badge = _badge_new(pkgname, pkgs, &err); + if (!badge) { + ERR("fail to _badge_new : %d", err); + free(pkgs); + return err; + } + free(pkgs); + + err = _badge_insert(badge); + if (err != BADGE_ERROR_NONE) { + ERR("fail to _badge_insert : %d", err); + _badge_free(badge); + return err; + } + + _badge_free(badge); + + return BADGE_ERROR_NONE; +} + +EXPORT_API +badge_error_e badge_db_delete(const char *pkgname, const char *caller) +{ + badge_error_e result = BADGE_ERROR_NONE; + + result = _badge_remove(caller, pkgname); + + return result; +} + +EXPORT_API +badge_error_e badge_db_set_count(const char *pkgname, const char *caller, int count) +{ + badge_error_e result = BADGE_ERROR_NONE; + + result = _badget_set_count(caller, pkgname, count); + + return result; +} + +EXPORT_API +badge_error_e badge_db_set_display_option(const char *pkgname, const char *caller, int is_display) +{ + badge_error_e result = BADGE_ERROR_NONE; + + result = _badget_set_display(pkgname, is_display); + + return result; +} + +EXPORT_API +badge_error_e badge_db_exec(sqlite3 * db, const char *query, int *num_changes) +{ + int ret = 0; + sqlite3_stmt *stmt = NULL; + + if (db == NULL) { + return BADGE_ERROR_INVALID_DATA; + } + if (query == NULL) { + return BADGE_ERROR_INVALID_DATA; + } + + ret = sqlite3_prepare_v2(db, query, strlen(query), &stmt, NULL); + if (ret != SQLITE_OK) { + ERR("DB err(%d) : %s", ret, + sqlite3_errmsg(db)); + return BADGE_ERROR_FROM_DB; + } + + if (stmt != NULL) { + ret = sqlite3_step(stmt); + if (ret == SQLITE_OK || ret == SQLITE_DONE) { + if (num_changes != NULL) { + *num_changes = sqlite3_changes(db); + } + sqlite3_finalize(stmt); + } else { + ERR("DB err(%d) : %s", ret, + sqlite3_errmsg(db)); + sqlite3_finalize(stmt); + return BADGE_ERROR_FROM_DB; + } + } else { + return BADGE_ERROR_FROM_DB; + } + + return BADGE_ERROR_NONE; +} diff --git a/src/badge_internal.c b/src/badge_internal.c new file mode 100755 index 0000000..f791cf4 --- /dev/null +++ b/src/badge_internal.c @@ -0,0 +1,1142 @@ +/* + * libbadge + * + * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved. + * + * Contact: Youngjoo Park <yjoo93.park@samsung.com>, + * Seungtaek Chung <seungtaek.chung@samsung.com>, Youngsub Ko <ys4610.ko@samsung.com> + * + * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * 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. + * + */ + +#include <string.h> +#include <stdlib.h> +#include <stdarg.h> +#include <fcntl.h> +#include <unistd.h> +#include <glib.h> +#include <dbus/dbus.h> +#include <dbus/dbus-glib-lowlevel.h> +#include <aul.h> +#include <sqlite3.h> +#include <db-util.h> + +#include "badge_log.h" +#include "badge_error.h" +#include "badge_internal.h" +#include "badge_ipc.h" +#include "badge_db.h" + +#define BADGE_PKGNAME_LEN 512 +#define BADGE_TABLE_NAME "badge_data" +#define BADGE_OPTION_TABLE_NAME "badge_option" + +#define BADGE_CHANGED_NOTI "badge_changed" + +struct _badge_h { + char *pkgname; + char *writable_pkgs; +}; + +struct _badge_cb_data { + badge_change_cb callback; + void *data; +}; + +static GList *g_badge_cb_list; + +static inline long _get_max_len(void) +{ + long max = 0; + long path_max_len = 4096; + +#ifdef _PC_PATH_MAX + max = (pathconf("/", _PC_PATH_MAX) < 1 ? path_max_len + : pathconf("/", _PC_PATH_MAX)); +#else /* _PC_PATH_MAX */ + max = path_max_len; +#endif /* _PC_PATH_MAX */ + return max; +} + +char *_badge_get_pkgname_by_pid(void) +{ + char *pkgname = NULL; + int pid = 0; + int ret = AUL_R_OK; + int fd = 0; + long max = 0; + + pid = getpid(); + max = _get_max_len(); + pkgname = malloc(max); + if (!pkgname) { + ERR("fail to alloc memory"); + return NULL; + } + memset(pkgname, 0x00, max); + + ret = aul_app_get_pkgname_bypid(pid, pkgname, max); + if (ret != AUL_R_OK) { + fd = open("/proc/self/cmdline", O_RDONLY); + if (fd < 0) { + free(pkgname); + return NULL; + } + + ret = read(fd, pkgname, max - 1); + if (ret <= 0) { + close(fd); + free(pkgname); + return NULL; + } + + close(fd); + } + + if (pkgname[0] == '\0') { + free(pkgname); + return NULL; + } else + return pkgname; +} + +static badge_error_e _badge_check_data_inserted(const char *pkgname, + sqlite3 *db) +{ + sqlite3_stmt *stmt = NULL; + int count = 0; + int result = BADGE_ERROR_NONE; + char *sqlbuf = NULL; + int sqlret; + + if (!pkgname) + return BADGE_ERROR_INVALID_DATA; + + if (!db) + return BADGE_ERROR_INVALID_DATA; + + sqlbuf = sqlite3_mprintf("SELECT count(*) FROM %s WHERE " \ + "pkgname = %Q", + BADGE_TABLE_NAME, pkgname); + + if (!sqlbuf) { + ERR("fail to alloc sql query"); + return BADGE_ERROR_NO_MEMORY; + } + + sqlret = sqlite3_prepare_v2(db, sqlbuf, -1, &stmt, NULL); + if (sqlret != SQLITE_OK) { + ERR("DB err [%s]", sqlite3_errmsg(db)); + ERR("query[%s]", sqlbuf); + result = BADGE_ERROR_FROM_DB; + goto free_and_return; + } + + sqlret = sqlite3_step(stmt); + if (sqlret == SQLITE_ROW) + count = sqlite3_column_int(stmt, 0); + else + count = 0; + + DBG("[%s], count[%d]", sqlbuf, count); + + if (count > 0) + result = BADGE_ERROR_ALREADY_EXIST; + else + result = BADGE_ERROR_NOT_EXIST; + +free_and_return: + if (sqlbuf) + sqlite3_free(sqlbuf); + + if (stmt) + sqlite3_finalize(stmt); + + return result; +} + +static badge_error_e _badge_check_option_inserted(const char *pkgname, + sqlite3 *db) +{ + sqlite3_stmt *stmt = NULL; + int count = 0; + int result = BADGE_ERROR_NONE; + char *sqlbuf = NULL; + int sqlret; + + if (!pkgname) + return BADGE_ERROR_INVALID_DATA; + + if (!db) + return BADGE_ERROR_INVALID_DATA; + + sqlbuf = sqlite3_mprintf("SELECT count(*) FROM %s WHERE " \ + "pkgname = %Q", + BADGE_OPTION_TABLE_NAME, pkgname); + + if (!sqlbuf) { + ERR("fail to alloc sql query"); + return BADGE_ERROR_NO_MEMORY; + } + + sqlret = sqlite3_prepare_v2(db, sqlbuf, -1, &stmt, NULL); + if (sqlret != SQLITE_OK) { + ERR("DB err [%s]", sqlite3_errmsg(db)); + ERR("query[%s]", sqlbuf); + result = BADGE_ERROR_FROM_DB; + goto free_and_return; + } + + sqlret = sqlite3_step(stmt); + if (sqlret == SQLITE_ROW) + count = sqlite3_column_int(stmt, 0); + else + count = 0; + + DBG("[%s], count[%d]", sqlbuf, count); + + if (count > 0) + result = BADGE_ERROR_ALREADY_EXIST; + else + result = BADGE_ERROR_NOT_EXIST; + +free_and_return: + if (sqlbuf) + sqlite3_free(sqlbuf); + + if (stmt) + sqlite3_finalize(stmt); + + return result; +} + +static badge_error_e _badge_check_writable(const char *caller, + const char *pkgname, sqlite3 *db) +{ + sqlite3_stmt *stmt = NULL; + int count = 0; + badge_error_e result = BADGE_ERROR_NONE; + char *sqlbuf = NULL; + int sqlret; + + if (!db) + return BADGE_ERROR_INVALID_DATA; + + if (!caller) + return BADGE_ERROR_INVALID_DATA; + + if (!pkgname) + return BADGE_ERROR_INVALID_DATA; + + if (g_strcmp0(caller, pkgname) == 0) + return BADGE_ERROR_NONE; + + sqlbuf = sqlite3_mprintf("SELECT COUNT(*) FROM %s WHERE " \ + "pkgname = %Q AND writable_pkgs LIKE '%%%q%%'", + BADGE_TABLE_NAME, + pkgname, caller); + if (!sqlbuf) { + ERR("fail to alloc sql query"); + return BADGE_ERROR_NO_MEMORY; + } + + sqlret = sqlite3_prepare_v2(db, sqlbuf, -1, &stmt, NULL); + if (sqlret != SQLITE_OK) { + ERR("DB err [%s]", sqlite3_errmsg(db)); + ERR("query[%s]", sqlbuf); + result = BADGE_ERROR_FROM_DB; + goto free_and_return; + } + + sqlret = sqlite3_step(stmt); + if (sqlret == SQLITE_ROW) + count = sqlite3_column_int(stmt, 0); + else + count = 0; + + DBG("[%s], count[%d]", sqlbuf, count); + + if (count <= 0) + result = BADGE_ERROR_PERMISSION_DENIED; + +free_and_return: + if (sqlbuf) + sqlite3_free(sqlbuf); + + if (stmt) + sqlite3_finalize(stmt); + + return result; +} + + +badge_error_e _badge_is_existing(const char *pkgname, bool *existing) +{ + sqlite3 *db = NULL; + int sqlret; + badge_error_e ret = BADGE_ERROR_NONE; + badge_error_e result = BADGE_ERROR_NONE; + + if (!pkgname || !existing) { + ERR("pkgname : %s, existing : %p", pkgname, existing); + return BADGE_ERROR_INVALID_DATA; + } + + sqlret = db_util_open(BADGE_DB_PATH, &db, 0); + if (sqlret != SQLITE_OK || !db) { + ERR("fail to db_util_open - [%d]", sqlret); + return BADGE_ERROR_FROM_DB; + } + + result = _badge_check_data_inserted(pkgname, db); + if (result == BADGE_ERROR_ALREADY_EXIST) + *existing = TRUE; + else if (result == BADGE_ERROR_NOT_EXIST) + *existing = FALSE; + else + ret = result; + + sqlret = db_util_close(db); + if (sqlret != SQLITE_OK) + WARN("fail to db_util_close - [%d]", sqlret); + + return BADGE_ERROR_NONE; +} + +badge_error_e _badge_foreach_existed(badge_cb callback, void *data) +{ + sqlite3 *db = NULL; + badge_error_e result = BADGE_ERROR_NONE; + char *sqlbuf = NULL; + sqlite3_stmt *stmt = NULL; + int sqlret; + + if (!callback) + return BADGE_ERROR_INVALID_DATA; + + sqlret = db_util_open(BADGE_DB_PATH, &db, 0); + if (sqlret != SQLITE_OK || !db) { + ERR("fail to db_util_open - [%d]", sqlret); + return BADGE_ERROR_FROM_DB; + } + + sqlbuf = sqlite3_mprintf("SELECT pkgname, badge FROM %s", + BADGE_TABLE_NAME); + if (!sqlbuf) { + ERR("fail to alloc sql query"); + result = BADGE_ERROR_NO_MEMORY; + goto free_and_return; + } + + sqlret = sqlite3_prepare_v2(db, sqlbuf, -1, &stmt, NULL); + if (sqlret != SQLITE_OK) { + ERR("fail to sqlite3_prepare_v2 - [%s]", sqlite3_errmsg(db)); + ERR("query[%s]", sqlbuf); + result = BADGE_ERROR_FROM_DB; + goto free_and_return; + } + + sqlret = sqlite3_step(stmt); + if (sqlret == SQLITE_DONE) { + INFO("badge db has no data"); + result = BADGE_ERROR_NOT_EXIST; + goto free_and_return; + } else if (sqlret == SQLITE_ROW) { + const char *pkg = NULL; + unsigned int badge_count = 0; + + pkg = (const char *)sqlite3_column_text(stmt, 0); + badge_count = (unsigned int)sqlite3_column_int(stmt, 1); + + if (pkg) + callback(pkg, badge_count, data); + else + ERR("db has invaild data"); + } else { + ERR("fail to sqlite3_step : %d", sqlret); + result = BADGE_ERROR_FROM_DB; + goto free_and_return; + } + + while (sqlite3_step(stmt) == SQLITE_ROW) { + const char *pkg = NULL; + unsigned int badge_count = 0; + + pkg = (const char *)sqlite3_column_text(stmt, 0); + badge_count = (unsigned int)sqlite3_column_int(stmt, 1); + + + if (pkg) + callback(pkg, badge_count, data); + else + ERR("db has invaild data"); + } + +free_and_return: + if (sqlbuf) + sqlite3_free(sqlbuf); + + if (stmt) + sqlite3_finalize(stmt); + + sqlret = db_util_close(db); + if (sqlret != SQLITE_OK) + WARN("fail to db_util_close - [%d]", sqlret); + + return result; +} + +badge_error_e _badge_insert(badge_h *badge) +{ + sqlite3 *db = NULL; + int sqlret; + badge_error_e ret = BADGE_ERROR_NONE; + badge_error_e result = BADGE_ERROR_NONE; + char *sqlbuf = NULL; + char *err_msg = NULL; + + if (!badge || !badge->pkgname || !badge->writable_pkgs) + return BADGE_ERROR_INVALID_DATA; + + sqlret = db_util_open(BADGE_DB_PATH, &db, 0); + if (sqlret != SQLITE_OK || !db) { + ERR("fail to db_util_open - [%s][%d]", BADGE_DB_PATH, sqlret); + return BADGE_ERROR_FROM_DB; + } + + /* Check pkgname & id */ + ret = _badge_check_data_inserted(badge->pkgname, db); + if (ret != BADGE_ERROR_NOT_EXIST) { + result = ret; + goto return_close_db; + } + + sqlbuf = sqlite3_mprintf("INSERT INTO %s " \ + "(pkgname, " \ + "writable_pkgs) " \ + "VALUES " + "(%Q, %Q);", + BADGE_TABLE_NAME, + badge->pkgname, badge->writable_pkgs); + if (!sqlbuf) { + ERR("fail to alloc query"); + result = BADGE_ERROR_NO_MEMORY; + goto return_close_db; + } + + ret = badge_db_exec(db, sqlbuf, NULL); + if (ret != BADGE_ERROR_NONE) { + ERR("failed to insert badge[%s], err[%d]", + badge->pkgname, ret); + result = ret; + goto return_close_db; + } + + /* inserting badge options */ + ret = _badge_check_option_inserted(badge->pkgname, db); + if (ret != BADGE_ERROR_NOT_EXIST) { + result = ret; + goto return_close_db; + } + + sqlbuf = sqlite3_mprintf("INSERT INTO %s " \ + "(pkgname) " \ + "VALUES " + "(%Q);", + BADGE_OPTION_TABLE_NAME, + badge->pkgname); + if (!sqlbuf) { + ERR("fail to alloc query"); + result = BADGE_ERROR_NO_MEMORY; + goto return_close_db; + } + + ret = badge_db_exec(db, sqlbuf, NULL); + if (ret != BADGE_ERROR_NONE) { + ERR("failed to insert badge option[%s], err[%d]", + badge->pkgname, sqlret); + result = ret; + goto return_close_db; + } + +return_close_db: + if (sqlbuf) + sqlite3_free(sqlbuf); + + sqlret = db_util_close(db); + if (sqlret != SQLITE_OK) + WARN("fail to db_util_close - [%d]", sqlret); + + return result; +} + +badge_error_e _badge_remove(const char *caller, const char *pkgname) +{ + badge_error_e ret = BADGE_ERROR_NONE; + badge_error_e result = BADGE_ERROR_NONE; + sqlite3 *db = NULL; + int sqlret; + char *sqlbuf = NULL; + + if (!caller) + return BADGE_ERROR_INVALID_DATA; + + if (!pkgname) + return BADGE_ERROR_INVALID_DATA; + + sqlret = db_util_open(BADGE_DB_PATH, &db, 0); + if (sqlret != SQLITE_OK || !db) { + ERR("fail to db_util_open - [%d]", sqlret); + return BADGE_ERROR_FROM_DB; + } + + ret = _badge_check_data_inserted(pkgname, db); + if (ret != BADGE_ERROR_ALREADY_EXIST) { + result = ret; + goto return_close_db; + } + + ret = _badge_check_writable(caller, pkgname, db); + if (ret != BADGE_ERROR_NONE) { + result = ret; + goto return_close_db; + } + + sqlbuf = sqlite3_mprintf("DELETE FROM %s WHERE pkgname = %Q", + BADGE_TABLE_NAME, pkgname); + if (!sqlbuf) { + ERR("fail to alloc query"); + result = BADGE_ERROR_NO_MEMORY; + goto return_close_db; + } + + ret = badge_db_exec(db, sqlbuf, NULL); + if (ret != BADGE_ERROR_NONE) { + ERR("failed to remove badge[%s], err[%d]", + pkgname, ret); + result = ret; + goto return_close_db; + } + + /* treating option table */ + ret = _badge_check_option_inserted(pkgname, db); + if (ret != BADGE_ERROR_ALREADY_EXIST) { + result = ret; + goto return_close_db; + } + + sqlbuf = sqlite3_mprintf("DELETE FROM %s WHERE pkgname = %Q", + BADGE_OPTION_TABLE_NAME, pkgname); + if (!sqlbuf) { + ERR("fail to alloc query"); + result = BADGE_ERROR_NO_MEMORY; + goto return_close_db; + } + + ret = badge_db_exec(db, sqlbuf, NULL); + if (ret != BADGE_ERROR_NONE) { + ERR("failed to remove badge option[%s], err[%d]", + pkgname, ret); + result = ret; + goto return_close_db; + } + +return_close_db: + if (sqlbuf) + sqlite3_free(sqlbuf); + + sqlret = db_util_close(db); + if (sqlret != SQLITE_OK) + WARN("fail to db_util_close - [%d]", sqlret); + + return result; +} + +badge_error_e _badget_set_count(const char *caller, const char *pkgname, + unsigned int count) +{ + badge_error_e ret = BADGE_ERROR_NONE; + badge_error_e result = BADGE_ERROR_NONE; + sqlite3 *db = NULL; + char *sqlbuf = NULL; + int sqlret; + char *err_msg = NULL; + + if (!caller) + return BADGE_ERROR_INVALID_DATA; + + if (!pkgname) + return BADGE_ERROR_INVALID_DATA; + + sqlret = db_util_open(BADGE_DB_PATH, &db, 0); + if (sqlret != SQLITE_OK || !db) { + ERR("fail to db_util_open - [%d]", sqlret); + return BADGE_ERROR_FROM_DB; + } + + ret = _badge_check_data_inserted(pkgname, db); + if (ret != BADGE_ERROR_ALREADY_EXIST) { + result = ret; + goto return_close_db; + } + + ret = _badge_check_writable(caller, pkgname, db); + if (ret != BADGE_ERROR_NONE) { + result = ret; + goto return_close_db; + } + + sqlbuf = sqlite3_mprintf("UPDATE %s SET badge = %d " \ + "WHERE pkgname = %Q", + BADGE_TABLE_NAME, count, pkgname); + if (!sqlbuf) { + ERR("fail to alloc query"); + result = BADGE_ERROR_NO_MEMORY; + goto return_close_db; + } + + ret = badge_db_exec(db, sqlbuf, NULL); + if (ret != BADGE_ERROR_NONE) { + ERR("failed to set badge[%s] count[%d], err[%d]", + pkgname, count, ret); + result = ret; + goto return_close_db; + } + +return_close_db: + if (sqlbuf) + sqlite3_free(sqlbuf); + + sqlret = db_util_close(db); + if (sqlret != SQLITE_OK) + WARN("fail to db_util_close - [%d]", sqlret); + + return result; +} + +badge_error_e _badget_get_count(const char *pkgname, unsigned int *count) +{ + badge_error_e ret = BADGE_ERROR_NONE; + badge_error_e result = BADGE_ERROR_NONE; + sqlite3 *db = NULL; + char *sqlbuf = NULL; + sqlite3_stmt *stmt = NULL; + int sqlret; + + if (!pkgname) + return BADGE_ERROR_INVALID_DATA; + + if (!count) + return BADGE_ERROR_INVALID_DATA; + + sqlret = db_util_open(BADGE_DB_PATH, &db, 0); + if (sqlret != SQLITE_OK || !db) { + ERR("fail to db_util_open - [%d]", sqlret); + return BADGE_ERROR_FROM_DB; + } + + ret = _badge_check_data_inserted(pkgname, db); + if (ret != BADGE_ERROR_ALREADY_EXIST) { + result = ret; + goto return_close_db; + } + + sqlbuf = sqlite3_mprintf("SELECT badge FROM %s " \ + "WHERE pkgname = %Q", + BADGE_TABLE_NAME, pkgname); + if (!sqlbuf) { + ERR("fail to alloc query"); + result = BADGE_ERROR_NO_MEMORY; + goto return_close_db; + } + + sqlret = sqlite3_prepare_v2(db, sqlbuf, -1, &stmt, NULL); + if (sqlret != SQLITE_OK) { + ERR("fail to prepare %s - [%s]", + sqlbuf, sqlite3_errmsg(db)); + result = BADGE_ERROR_FROM_DB; + goto return_close_db; + } + + sqlret = sqlite3_step(stmt); + if (sqlret == SQLITE_ROW) + *count = (unsigned int)sqlite3_column_int(stmt, 0); + else + *count = (unsigned int)0; + +return_close_db: + if (sqlbuf) + sqlite3_free(sqlbuf); + + if (stmt) + sqlite3_finalize(stmt); + + sqlret = db_util_close(db); + if (sqlret != SQLITE_OK) + WARN("fail to db_util_close - [%d]", sqlret); + + return result; +} + +badge_error_e _badget_set_display(const char *pkgname, + unsigned int is_display) +{ + badge_error_e ret = BADGE_ERROR_NONE; + badge_error_e result = BADGE_ERROR_NONE; + sqlite3 *db = NULL; + char *sqlbuf = NULL; + int sqlret; + char *err_msg = NULL; + + if (!pkgname) + return BADGE_ERROR_INVALID_DATA; + + if (is_display != 0 && is_display != 1) + return BADGE_ERROR_INVALID_DATA; + + sqlret = db_util_open(BADGE_DB_PATH, &db, 0); + if (sqlret != SQLITE_OK || !db) { + ERR("fail to db_util_open - [%d]", sqlret); + return BADGE_ERROR_FROM_DB; + } + + ret = _badge_check_option_inserted(pkgname, db); + if (ret == BADGE_ERROR_ALREADY_EXIST) { + sqlbuf = sqlite3_mprintf("UPDATE %s SET display = %d " \ + "WHERE pkgname = %Q", + BADGE_OPTION_TABLE_NAME, is_display, pkgname); + if (!sqlbuf) { + ERR("fail to alloc query"); + result = BADGE_ERROR_NO_MEMORY; + goto return_close_db; + } + + ret = badge_db_exec(db, sqlbuf, NULL); + if (ret != BADGE_ERROR_NONE) { + ERR("failed to set badge[%s] option[%d], err[%d]", + pkgname, is_display, ret); + result = ret; + goto return_close_db; + } + } else if (ret == BADGE_ERROR_NOT_EXIST) { + sqlbuf = sqlite3_mprintf("INSERT INTO %s " \ + "(pkgname, " \ + "display) " \ + "VALUES " + "(%Q, %d);", + BADGE_OPTION_TABLE_NAME, + pkgname, is_display); + if (!sqlbuf) { + ERR("fail to alloc query"); + result = BADGE_ERROR_NO_MEMORY; + goto return_close_db; + } + + ret = badge_db_exec(db, sqlbuf, NULL); + if (ret != BADGE_ERROR_NONE) { + ERR("failed to set badge[%s] option[%d], err[%d]", + pkgname, is_display, ret); + result = ret; + goto return_close_db; + } + } else { + result = ret; + goto return_close_db; + } + +return_close_db: + if (sqlbuf) + sqlite3_free(sqlbuf); + + sqlret = db_util_close(db); + if (sqlret != SQLITE_OK) + WARN("fail to db_util_close - [%d]", sqlret); + + return result; +} + +badge_error_e _badget_get_display(const char *pkgname, unsigned int *is_display) +{ + badge_error_e ret = BADGE_ERROR_NONE; + badge_error_e result = BADGE_ERROR_NONE; + sqlite3 *db = NULL; + char *sqlbuf = NULL; + sqlite3_stmt *stmt = NULL; + int sqlret; + + if (!pkgname) + return BADGE_ERROR_INVALID_DATA; + + if (!is_display) + return BADGE_ERROR_INVALID_DATA; + + sqlret = db_util_open(BADGE_DB_PATH, &db, 0); + if (sqlret != SQLITE_OK || !db) { + ERR("fail to db_util_open - [%d]", sqlret); + return BADGE_ERROR_FROM_DB; + } + + ret = _badge_check_option_inserted(pkgname, db); + if (ret != BADGE_ERROR_ALREADY_EXIST) { + if (ret == BADGE_ERROR_NOT_EXIST) { + *is_display = 1; + } + result = ret; + goto return_close_db; + } + + sqlbuf = sqlite3_mprintf("SELECT display FROM %s " \ + "WHERE pkgname = %Q", + BADGE_OPTION_TABLE_NAME, pkgname); + if (!sqlbuf) { + ERR("fail to alloc query"); + result = BADGE_ERROR_NO_MEMORY; + goto return_close_db; + } + + sqlret = sqlite3_prepare_v2(db, sqlbuf, -1, &stmt, NULL); + if (sqlret != SQLITE_OK) { + ERR("fail to prepare %s - [%s]", + sqlbuf, sqlite3_errmsg(db)); + result = BADGE_ERROR_FROM_DB; + goto return_close_db; + } + + sqlret = sqlite3_step(stmt); + if (sqlret == SQLITE_ROW) + *is_display = (unsigned int)sqlite3_column_int(stmt, 0); + else + *is_display = (unsigned int)1; + +return_close_db: + if (sqlbuf) + sqlite3_free(sqlbuf); + + if (stmt) + sqlite3_finalize(stmt); + + sqlret = db_util_close(db); + if (sqlret != SQLITE_OK) + WARN("fail to db_util_close - [%d]", sqlret); + + return result; +} + +void badge_changed_cb_call(unsigned int action, const char *pkgname, + unsigned int count) +{ + GList *list = g_badge_cb_list; + + while (list) { + struct _badge_cb_data *bd = g_list_nth_data(list, 0); + if (!bd) + continue; + + if (bd->callback) + bd->callback(action, pkgname, count, bd->data); + + list = g_list_next(list); + } +} + +static void _badge_changed_monitor_init() +{ + badge_ipc_monitor_init(); +} + +static void _badge_chanaged_monitor_fini() +{ + badge_ipc_monitor_fini(); +} + +static gint _badge_data_compare(gconstpointer a, gconstpointer b) +{ + const struct _badge_cb_data *bd = NULL; + + if (!a) + return -1; + bd = a; + + if (bd->callback == b) + return 0; + + return 1; +} + +badge_error_e _badge_register_changed_cb(badge_change_cb callback, void *data) +{ + struct _badge_cb_data *bd = NULL; + GList *found = NULL; + + if (!callback) + return BADGE_ERROR_INVALID_DATA; + + _badge_changed_monitor_init(); + + found = g_list_find_custom(g_badge_cb_list, (gconstpointer)callback, + _badge_data_compare); + + if (found) { + bd = g_list_nth_data(found, 0); + bd->data = data; + } else { + + bd = malloc(sizeof(struct _badge_cb_data)); + if (!bd) + return BADGE_ERROR_NO_MEMORY; + + + bd->callback = callback; + bd->data = data; + + g_badge_cb_list = g_list_append(g_badge_cb_list, bd); + } + return BADGE_ERROR_NONE; +} + +badge_error_e _badge_unregister_changed_cb(badge_change_cb callback) +{ + GList *found = NULL; + + if (!callback) + return BADGE_ERROR_INVALID_DATA; + + found = g_list_find_custom(g_badge_cb_list, (gconstpointer)callback, + _badge_data_compare); + + if (found) { + struct _badge_cb_data *bd = g_list_nth_data(found, 0); + g_badge_cb_list = g_list_delete_link(g_badge_cb_list, found); + free(bd); + } + + if (!g_badge_cb_list) + _badge_chanaged_monitor_fini(); + + return BADGE_ERROR_NONE; +} + +badge_error_e _badge_free(badge_h *badge) +{ + if (!badge) + return BADGE_ERROR_INVALID_DATA; + + if (badge->pkgname) + free(badge->pkgname); + + if (badge->writable_pkgs) + free(badge->writable_pkgs); + + free(badge); + + return BADGE_ERROR_NONE; +} + +badge_h *_badge_new(const char *pkgname, const char *writable_pkgs, + badge_error_e *err) +{ + badge_h *badge = NULL; + + if (!pkgname) { + ERR("PKGNAME is NULL"); + if (err) + *err = BADGE_ERROR_INVALID_DATA; + return NULL; + } + + if (!writable_pkgs) { + ERR("writable_pkgs is NULL"); + if (err) + *err = BADGE_ERROR_INVALID_DATA; + return NULL; + } + + + badge = (badge_h *)malloc(sizeof(struct _badge_h)); + if (!badge) { + ERR("fail to alloc handle"); + if (err) + *err = BADGE_ERROR_NO_MEMORY; + return NULL; + } + + badge->pkgname = strdup(pkgname); + badge->writable_pkgs = strdup(writable_pkgs); + if (err) + *err = BADGE_ERROR_NONE; + + return badge; +} + +char *_badge_pkgs_new(badge_error_e *err, const char *pkg1, ...) +{ + char *caller_pkgname = NULL; + char *s = NULL; + char *result = NULL; + char *ptr = NULL; + gsize length; + va_list args; + + + if (err) + *err = BADGE_ERROR_NONE; + + caller_pkgname = _badge_get_pkgname_by_pid(); + if (!caller_pkgname) { + ERR("fail to get caller pkgname"); + if (err) + *err = BADGE_ERROR_PERMISSION_DENIED; + return NULL; + } + + if (!pkg1) { + WARN("pkg1 is NULL"); + return caller_pkgname; + } + + length = strlen(pkg1); + va_start(args, pkg1); + s = va_arg(args, char *); + while (s) { + length += strlen(s) ; + s = va_arg(args, char *); + } + va_end(args); + + if (length <= 0) { + WARN("length is %d", length); + return caller_pkgname; + } + + result = g_new0(char, length + 1); /* 1 for null terminate */ + if (!result) { + ERR("fail to alloc memory"); + if (err) + *err = BADGE_ERROR_NO_MEMORY; + free(caller_pkgname); + return NULL; + } + + ptr = result; + ptr = g_stpcpy(ptr, pkg1); + va_start(args, pkg1); + s = va_arg(args, char *); + while (s) { + ptr = g_stpcpy(ptr, s); + s = va_arg(args, char *); + } + va_end(args); + + if (g_strstr_len(result, -1, caller_pkgname) == NULL) { + char *new_pkgs = NULL; + new_pkgs = g_strdup_printf("%s%s", caller_pkgname, result); + if (!new_pkgs) { + ERR("fail to alloc memory"); + if (err) + *err = BADGE_ERROR_NO_MEMORY; + + free(result); + free(caller_pkgname); + return NULL; + } + free(result); + result = new_pkgs; + } + + free(caller_pkgname); + + return result; +} + +char *_badge_pkgs_new_valist(badge_error_e *err, const char *pkg1, va_list args) +{ + char *caller_pkgname = NULL; + char *s = NULL; + char *result = NULL; + char *ptr = NULL; + gsize length; + va_list args2; + + if (err) + *err = BADGE_ERROR_NONE; + + caller_pkgname = _badge_get_pkgname_by_pid(); + if (!caller_pkgname) { + ERR("fail to get caller pkgname"); + if (err) + *err = BADGE_ERROR_PERMISSION_DENIED; + return NULL; + } + + if (!pkg1) { + WARN("pkg1 is NULL"); + return caller_pkgname; + } + + G_VA_COPY(args2, args); + + length = strlen(pkg1); + s = va_arg(args, char *); + while (s) { + length += strlen(s) ; + s = va_arg(args, char *); + } + + if (length <= 0) { + WARN("length is %d", length); + va_end(args2); + return caller_pkgname; + } + + result = g_new0(char, length + 1); /* 1 for null terminate */ + if (!result) { + ERR("fail to alloc memory"); + if (err) + *err = BADGE_ERROR_NO_MEMORY; + free(caller_pkgname); + va_end(args2); + return NULL; + } + + ptr = result; + ptr = g_stpcpy(ptr, pkg1); + s = va_arg(args2, char *); + while (s) { + ptr = g_stpcpy(ptr, s); + s = va_arg(args2, char *); + } + va_end(args2); + + if (g_strstr_len(result, -1, caller_pkgname) == NULL) { + char *new_pkgs = NULL; + new_pkgs = g_strdup_printf("%s%s", caller_pkgname, result); + if (!new_pkgs) { + ERR("fail to alloc memory"); + if (err) + *err = BADGE_ERROR_NO_MEMORY; + + free(result); + free(caller_pkgname); + return NULL; + } + free(result); + result = new_pkgs; + } + + free(caller_pkgname); + + return result; +} + diff --git a/src/badge_ipc.c b/src/badge_ipc.c new file mode 100755 index 0000000..7cb728d --- /dev/null +++ b/src/badge_ipc.c @@ -0,0 +1,693 @@ +/* + * libbadge + * + * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved. + * + * Contact: Youngjoo Park <yjoo93.park@samsung.com>, + * Seungtaek Chung <seungtaek.chung@samsung.com>, Youngsub Ko <ys4610.ko@samsung.com> + * + * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * 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. + * + */ + +#include <stdlib.h> +#include <stdarg.h> + +#include <vconf.h> + +#include <packet.h> +#include <com-core.h> +#include <com-core_packet.h> + +#include "badge.h" +#include "badge_log.h" +#include "badge_error.h" +#include "badge_internal.h" +#include "badge_ipc.h" + +#define BADGE_IPC_TIMEOUT 1.0 + +#if !defined(VCONFKEY_MASTER_STARTED) +#define VCONFKEY_MASTER_STARTED "memory/data-provider-master/started" +#endif + +static struct info { + int server_fd; + int client_fd; + const char *socket_file; + struct { + int (*request_cb)(const char *appid, const char *name, int type, const char *content, const char *icon, pid_t pid, double period, int allow_duplicate, void *data); + void *data; + } server_cb; + int initialized; + int is_started_cb_set_svc; + int is_started_cb_set_task; +} s_info = { + .server_fd = -1, + .client_fd = -1, + .socket_file = BADGE_ADDR, + .initialized = 0, + .is_started_cb_set_svc = 0, + .is_started_cb_set_task = 0, +}; + +typedef struct _task_list task_list; +struct _task_list { + task_list *prev; + task_list *next; + + void (*task_cb) (void *data); + void *data; +}; + +static task_list *g_task_list; + +static badge_error_e badge_ipc_monitor_register(void); +static badge_error_e badge_ipc_monitor_deregister(void); +static void _do_deffered_task(void); +static void _master_started_cb_task(keynode_t *node, void *data); + +/*! + * functions to check state of master + */ +static inline void _set_master_started_cb(vconf_callback_fn cb) { + int ret = -1; + + ret = vconf_notify_key_changed(VCONFKEY_MASTER_STARTED, + cb, NULL); + if (ret != 0) { + ERR("failed to notify key(%s) : %d", + VCONFKEY_MASTER_STARTED, ret); + } +} + +static inline void _unset_master_started_cb(vconf_callback_fn cb) { + int ret = -1; + + ret = vconf_ignore_key_changed(VCONFKEY_MASTER_STARTED, + cb); + if (ret != 0) { + ERR("failed to notify key(%s) : %d", + VCONFKEY_MASTER_STARTED, ret); + } +} + +int badge_ipc_is_master_ready(void) +{ + int ret = -1, is_master_started = 0; + + ret = vconf_get_bool(VCONFKEY_MASTER_STARTED, &is_master_started); + if (ret == 0 && is_master_started == 1) { + ERR("the master has been started"); + } else { + is_master_started = 0; + ERR("the master has been stopped"); + } + + return is_master_started; +} + +badge_error_e +badge_ipc_add_deffered_task( + void (*deffered_task_cb)(void *data), + void *user_data) +{ + task_list *list = NULL; + task_list *list_new = NULL; + + list_new = + (task_list *) malloc(sizeof(task_list)); + + if (list_new == NULL) { + return BADGE_ERROR_NO_MEMORY; + } + + if (s_info.is_started_cb_set_task == 0) { + _set_master_started_cb(_master_started_cb_task); + s_info.is_started_cb_set_task = 1; + } + + list_new->next = NULL; + list_new->prev = NULL; + + list_new->task_cb = deffered_task_cb; + list_new->data = user_data; + + if (g_task_list == NULL) { + g_task_list = list_new; + } else { + list = g_task_list; + + while (list->next != NULL) { + list = list->next; + } + + list->next = list_new; + list_new->prev = list; + } + return BADGE_ERROR_NONE; +} + +badge_error_e +badge_ipc_del_deffered_task( + void (*deffered_task_cb)(void *data)) +{ + task_list *list_del = NULL; + task_list *list_prev = NULL; + task_list *list_next = NULL; + + list_del = g_task_list; + + if (list_del == NULL) { + return BADGE_ERROR_INVALID_DATA; + } + + while (list_del->prev != NULL) { + list_del = list_del->prev; + } + + do { + if (list_del->task_cb == deffered_task_cb) { + list_prev = list_del->prev; + list_next = list_del->next; + + if (list_prev == NULL) { + g_task_list = list_next; + } else { + list_prev->next = list_next; + } + + if (list_next == NULL) { + if (list_prev != NULL) { + list_prev->next = NULL; + } + } else { + list_next->prev = list_prev; + } + + free(list_del); + + if (g_task_list == NULL) { + if (s_info.is_started_cb_set_task == 1) { + _unset_master_started_cb(_master_started_cb_task); + s_info.is_started_cb_set_task = 0; + } + } + + return BADGE_ERROR_NONE; + } + list_del = list_del->next; + } while (list_del != NULL); + + return BADGE_ERROR_INVALID_DATA; +} + +static void _do_deffered_task(void) { + task_list *list_do = NULL; + task_list *list_temp = NULL; + + if (g_task_list == NULL) { + return; + } + + list_do = g_task_list; + g_task_list = NULL; + if (s_info.is_started_cb_set_task == 1) { + _unset_master_started_cb(_master_started_cb_task); + s_info.is_started_cb_set_task = 0; + } + + while (list_do->prev != NULL) { + list_do = list_do->prev; + } + + while (list_do != NULL) { + if (list_do->task_cb != NULL) { + list_do->task_cb(list_do->data); + DBG("called:%p", list_do->task_cb); + } + list_temp = list_do->next; + free(list_do); + list_do = list_temp; + } +} + +static void _master_started_cb_service(keynode_t *node, + void *data) { + int ret = BADGE_ERROR_NONE; + + if (badge_ipc_is_master_ready()) { + ERR("try to register a badge service"); + ret = badge_ipc_monitor_deregister(); + if (ret != BADGE_ERROR_NONE) { + ERR("failed to deregister a monitor"); + } + ret = badge_ipc_monitor_register(); + if (ret != BADGE_ERROR_NONE) { + ERR("failed to register a monitor"); + } + } else { + ERR("try to unregister a badge service"); + ret = badge_ipc_monitor_deregister(); + if (ret != BADGE_ERROR_NONE) { + ERR("failed to deregister a monitor"); + } + } +} + +static void _master_started_cb_task(keynode_t *node, + void *data) { + + if (badge_ipc_is_master_ready()) { + _do_deffered_task(); + } +} + +/*! + * functions to handler services + */ +static struct packet *_handler_insert_badge(pid_t pid, int handle, const struct packet *packet) +{ + int ret = 0; + char *pkgname = NULL; + + if (!packet) { + ERR("a packet is null"); + return NULL; + } + + DBG(""); + + //return code, pkgname + if (packet_get(packet, "is", &ret, &pkgname) == 2) { + if (ret == BADGE_ERROR_NONE) { + badge_changed_cb_call(BADGE_ACTION_CREATE, pkgname, 0); + } else { + ERR("failed to insert a new badge:%d", ret); + } + } else { + ERR("failed to get data from a packet"); + } + + return NULL; +} + +static struct packet *_handler_delete_badge(pid_t pid, int handle, const struct packet *packet) +{ + int ret = 0; + char *pkgname = NULL; + + if (!packet) { + ERR("a packet is null"); + return NULL; + } + + DBG(""); + + if (packet_get(packet, "is", &ret, &pkgname) == 2) { + if (ret == BADGE_ERROR_NONE) { + badge_changed_cb_call(BADGE_ACTION_REMOVE, pkgname, 0); + } else { + ERR("failed to remove a badge:%d", ret); + } + } else { + ERR("failed to get data from a packet"); + } + + return NULL; +} + +static struct packet *_handler_set_badge_count(pid_t pid, int handle, const struct packet *packet) +{ + int ret = 0; + char *pkgname = NULL; + int count = 0; + + if (!packet) { + ERR("a packet is null"); + return NULL; + } + + DBG(""); + + if (packet_get(packet, "isi", &ret, &pkgname, &count) == 3) { + if (ret == BADGE_ERROR_NONE) { + badge_changed_cb_call(BADGE_ACTION_UPDATE, pkgname, count); + } else { + ERR("failed to update count of badge:%d", ret); + } + } else { + ERR("failed to get data from a packet"); + } + + return NULL; +} + +static struct packet *_handler_set_display_option(pid_t pid, int handle, const struct packet *packet) +{ + int ret = 0; + char *pkgname = NULL; + int is_display = 0; + + if (!packet) { + ERR("a packet is null"); + return NULL; + } + + DBG(""); + + if (packet_get(packet, "isi", &ret, &pkgname, &is_display) == 3) { + if (ret == BADGE_ERROR_NONE) { + badge_changed_cb_call(BADGE_ACTION_CHANGED_DISPLAY, pkgname, is_display); + } else { + ERR("failed to update the display option of badge:%d, %d", ret, is_display); + } + } else { + ERR("failed to get data from a packet"); + } + + return NULL; +} + +static int _handler_service_register(pid_t pid, int handle, const struct packet *packet, void *data) +{ + int ret; + + DBG(""); + + if (!packet) { + ERR("Packet is not valid\n"); + ret = BADGE_ERROR_INVALID_DATA; + } else if (packet_get(packet, "i", &ret) != 1) { + ERR("Packet is not valid\n"); + ret = BADGE_ERROR_INVALID_DATA; + } else { + if (ret == BADGE_ERROR_NONE) { + badge_changed_cb_call(BADGE_ACTION_SERVICE_READY, NULL, 0); + } + } + return ret; +} + +/*! + * functions to initialize and register a monitor + */ +static badge_error_e badge_ipc_monitor_register(void) +{ + int ret; + struct packet *packet; + static struct method service_table[] = { + { + .cmd = "insert_badge", + .handler = _handler_insert_badge, + }, + { + .cmd = "delete_badge", + .handler = _handler_delete_badge, + }, + { + .cmd = "set_badge_count", + .handler = _handler_set_badge_count, + }, + { + .cmd = "set_disp_option", + .handler = _handler_set_display_option, + }, + { + .cmd = NULL, + .handler = NULL, + }, + }; + + if (s_info.initialized == 1) { + return BADGE_ERROR_NONE; + } else { + s_info.initialized = 1; + } + + ERR("register a service\n"); + + s_info.server_fd = com_core_packet_client_init(s_info.socket_file, 0, service_table); + if (s_info.server_fd < 0) { + ERR("Failed to make a connection to the master\n"); + return BADGE_ERROR_IO; + } + + packet = packet_create("service_register", ""); + if (!packet) { + ERR("Failed to build a packet\n"); + return BADGE_ERROR_IO; + } + + ret = com_core_packet_async_send(s_info.server_fd, packet, 1.0, _handler_service_register, NULL); + DBG("Service register sent: %d\n", ret); + packet_destroy(packet); + if (ret != 0) { + com_core_packet_client_fini(s_info.server_fd); + s_info.server_fd = BADGE_ERROR_INVALID_DATA; + ret = BADGE_ERROR_IO; + } else { + ret = BADGE_ERROR_NONE; + } + + DBG("Server FD: %d\n", s_info.server_fd); + return ret; +} + +badge_error_e badge_ipc_monitor_deregister(void) +{ + if (s_info.initialized == 0) { + return BADGE_ERROR_NONE; + } + + com_core_packet_client_fini(s_info.server_fd); + s_info.server_fd = BADGE_ERROR_INVALID_DATA; + + s_info.initialized = 0; + + return BADGE_ERROR_NONE; +} + +badge_error_e badge_ipc_monitor_init(void) +{ + int ret = BADGE_ERROR_NONE; + + if (badge_ipc_is_master_ready()) { + ret = badge_ipc_monitor_register(); + } + + if (s_info.is_started_cb_set_svc == 0) { + _set_master_started_cb(_master_started_cb_service); + s_info.is_started_cb_set_svc = 1; + } + + return ret; +} + +badge_error_e badge_ipc_monitor_fini(void) +{ + int ret = BADGE_ERROR_NONE; + + if (s_info.is_started_cb_set_svc == 1) { + _unset_master_started_cb(_master_started_cb_service); + s_info.is_started_cb_set_svc = 0; + } + + ret = badge_ipc_monitor_deregister(); + + return ret; +} + + +badge_error_e badge_ipc_request_insert(const char *pkgname, const char *writable_pkg, const char *caller) { + int ret = 0; + struct packet *packet; + struct packet *result; + + packet = packet_create("insert_badge", "sss", pkgname, writable_pkg, caller); + result = com_core_packet_oneshot_send(BADGE_ADDR, + packet, + BADGE_IPC_TIMEOUT); + packet_destroy(packet); + + if (result != NULL) { + if (packet_get(result, "i", &ret) != 1) { + ERR("Failed to get a result packet"); + packet_unref(result); + return BADGE_ERROR_IO; + } + + if (ret != BADGE_ERROR_NONE) { + packet_unref(result); + return ret; + } + packet_unref(result); + } else { + badge_ipc_is_master_ready(); + return BADGE_ERROR_SERVICE_NOT_READY; + } + + return BADGE_ERROR_NONE; +} + +badge_error_e badge_ipc_request_delete(const char *pkgname, const char *caller) { + int ret = 0; + struct packet *packet; + struct packet *result; + + packet = packet_create("delete_badge", "ss", pkgname, caller); + result = com_core_packet_oneshot_send(BADGE_ADDR, + packet, + BADGE_IPC_TIMEOUT); + packet_destroy(packet); + + if (result != NULL) { + if (packet_get(result, "i", &ret) != 1) { + ERR("Failed to get a result packet"); + packet_unref(result); + return BADGE_ERROR_IO; + } + + if (ret != BADGE_ERROR_NONE) { + packet_unref(result); + return ret; + } + packet_unref(result); + } else { + badge_ipc_is_master_ready(); + return BADGE_ERROR_SERVICE_NOT_READY; + } + + return BADGE_ERROR_NONE; +} + +badge_error_e badge_ipc_request_set_count(const char *pkgname, const char *caller, int count) { + int ret = 0; + struct packet *packet; + struct packet *result; + + packet = packet_create("set_badge_count", "ssi", pkgname, caller, count); + result = com_core_packet_oneshot_send(BADGE_ADDR, + packet, + BADGE_IPC_TIMEOUT); + packet_destroy(packet); + + if (result != NULL) { + if (packet_get(result, "i", &ret) != 1) { + ERR("Failed to get a result packet"); + packet_unref(result); + return BADGE_ERROR_IO; + } + + if (ret != BADGE_ERROR_NONE) { + packet_unref(result); + return ret; + } + packet_unref(result); + } else { + badge_ipc_is_master_ready(); + return BADGE_ERROR_SERVICE_NOT_READY; + } + + return BADGE_ERROR_NONE; +} + +badge_error_e badge_ipc_request_set_display(const char *pkgname, const char *caller, int display_option) { + int ret = 0; + struct packet *packet; + struct packet *result; + + packet = packet_create("set_disp_option", "ssi", pkgname, caller, display_option); + result = com_core_packet_oneshot_send(BADGE_ADDR, + packet, + BADGE_IPC_TIMEOUT); + packet_destroy(packet); + + if (result != NULL) { + if (packet_get(result, "i", &ret) != 1) { + ERR("Failed to get a result packet"); + packet_unref(result); + return BADGE_ERROR_IO; + } + + if (ret != BADGE_ERROR_NONE) { + packet_unref(result); + return ret; + } + packet_unref(result); + } else { + badge_ipc_is_master_ready(); + return BADGE_ERROR_SERVICE_NOT_READY; + } + + return BADGE_ERROR_NONE; +} + +badge_error_e badge_ipc_setting_property_set(const char *pkgname, const char *property, const char *value) +{ + int status = 0; + int ret = 0; + struct packet *packet; + struct packet *result; + + packet = packet_create("set_noti_property", "sss", pkgname, property, value); + result = com_core_packet_oneshot_send(BADGE_ADDR, + packet, + BADGE_IPC_TIMEOUT); + packet_destroy(packet); + + if (result != NULL) { + if (packet_get(result, "ii", &status, &ret) != 2) { + ERR("Failed to get a result packet"); + packet_unref(result); + return BADGE_ERROR_IO; + } + packet_unref(result); + } else { + ERR("failed to receive answer(delete)"); + return BADGE_ERROR_SERVICE_NOT_READY; + } + + return status; +} + +badge_error_e badge_ipc_setting_property_get(const char *pkgname, const char *property, char **value) +{ + int status = 0; + char *ret = NULL; + struct packet *packet; + struct packet *result; + + packet = packet_create("get_noti_property", "ss", pkgname, property); + result = com_core_packet_oneshot_send(BADGE_ADDR, + packet, + BADGE_IPC_TIMEOUT); + packet_destroy(packet); + + if (result != NULL) { + if (packet_get(result, "is", &status, &ret) != 2) { + ERR("Failed to get a result packet"); + packet_unref(result); + return BADGE_ERROR_IO; + } + if (status == BADGE_ERROR_NONE && ret != NULL) { + *value = strdup(ret); + } + packet_unref(result); + } else { + ERR("failed to receive answer(delete)"); + return BADGE_ERROR_SERVICE_NOT_READY; + } + + return status; +} diff --git a/src/badge_setting.c b/src/badge_setting.c new file mode 100755 index 0000000..749c778 --- /dev/null +++ b/src/badge_setting.c @@ -0,0 +1,324 @@ +/* + * libbadge + * + * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved. + * + * Contact: Youngjoo Park <yjoo93.park@samsung.com>, + * Seungtaek Chung <seungtaek.chung@samsung.com>, Youngsub Ko <ys4610.ko@samsung.com> + * + * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * 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. + * + */ + +#include <stdlib.h> +#include <stdarg.h> +#include <sqlite3.h> +#include <db-util.h> + +#include "badge.h" +#include "badge_log.h" +#include "badge_error.h" +#include "badge_internal.h" +#include "badge_ipc.h" +#include "badge_setting.h" +#include "badge_db.h" + +#define SETTING_DB_TABLE "notification_setting" +#define SETTING_DB_FILE "/opt/usr/dbspace/.notification_parser.db" + +struct prop_table { + const char *property; + const char *column; + const char *default_value; +}; + +static struct prop_table g_prop_table[] = { + { + .property = "OPT_BADGE", + .column = "badge", + .default_value = "ON", + }, + { + .property = NULL, + .column = NULL, + .default_value = NULL, + } +}; + +static const char *_get_prop_column(const char *property) +{ + int i; + + for (i = 0; g_prop_table[i].property; i++) { + if (strcmp(g_prop_table[i].property, property)) + continue; + + return g_prop_table[i].column; + } + + return NULL; +} + +#ifdef TBD +static const char *_get_prop_default_value(const char *property) +{ + int i; + + for (i = 0; g_prop_table[i].property; i++) { + if (strcmp(g_prop_table[i].property, property)) + continue; + + return g_prop_table[i].default_value; + } + + return NULL; +} +#endif + +static badge_error_e _is_record_exist(const char *pkgname, sqlite3 *db) +{ + sqlite3_stmt *stmt = NULL; + int count = 0; + int result = BADGE_ERROR_NONE; + char *sqlbuf = NULL; + int sqlret; + + if (!pkgname) + return BADGE_ERROR_INVALID_DATA; + + if (!db) + return BADGE_ERROR_INVALID_DATA; + + sqlbuf = sqlite3_mprintf("SELECT count(*) FROM %s WHERE " \ + "appid = %Q", + SETTING_DB_TABLE, pkgname); + + if (!sqlbuf) { + ERR("fail to alloc sql query"); + return BADGE_ERROR_NO_MEMORY; + } + + sqlret = sqlite3_prepare_v2(db, sqlbuf, -1, &stmt, NULL); + if (sqlret != SQLITE_OK) { + ERR("DB err [%s]", sqlite3_errmsg(db)); + ERR("query[%s]", sqlbuf); + result = BADGE_ERROR_FROM_DB; + goto free_and_return; + } + + sqlret = sqlite3_step(stmt); + if (sqlret == SQLITE_ROW) + count = sqlite3_column_int(stmt, 0); + else + count = 0; + + if (count > 0) + result = BADGE_ERROR_ALREADY_EXIST; + else + result = BADGE_ERROR_NOT_EXIST; + +free_and_return: + if (sqlbuf) + sqlite3_free(sqlbuf); + + if (stmt) + sqlite3_finalize(stmt); + + return result; +} + +EXPORT_API badge_error_e badge_setting_db_set(const char *pkgname, const char *property, const char *value) +{ + badge_error_e ret = BADGE_ERROR_NONE; + badge_error_e result = BADGE_ERROR_NONE; + sqlite3 *db = NULL; + char *sqlbuf = NULL; + int sqlret; + const char *column = NULL; + + if (!pkgname) + return BADGE_ERROR_INVALID_DATA; + + if (!property) + return BADGE_ERROR_INVALID_DATA; + + if (!value) + return BADGE_ERROR_INVALID_DATA; + + column = _get_prop_column(property); + if (!column) + return BADGE_ERROR_INVALID_DATA; + + sqlret = db_util_open(SETTING_DB_FILE, &db, 0); + if (sqlret != SQLITE_OK || !db) { + ERR("fail to db_util_open - [%d]", sqlret); + return BADGE_ERROR_FROM_DB; + } + + ret = _is_record_exist(pkgname, db); + if (ret != BADGE_ERROR_ALREADY_EXIST) { + result = ret; + goto return_close_db; + } + + sqlbuf = sqlite3_mprintf("UPDATE %s SET %s = %Q " \ + "WHERE appid = %Q", + SETTING_DB_TABLE, column, value, pkgname); + if (!sqlbuf) { + ERR("fail to alloc query"); + result = BADGE_ERROR_NO_MEMORY; + goto return_close_db; + } + + ret = badge_db_exec(db, sqlbuf, NULL); + if (ret != BADGE_ERROR_NONE) { + ERR("failed to set pkgname[%s] option[%s], value[%s], err[%d]", + pkgname, column, value, ret); + result = ret; + goto return_close_db; + } + +return_close_db: + if (sqlbuf) + sqlite3_free(sqlbuf); + + sqlret = db_util_close(db); + if (sqlret != SQLITE_OK) + WARN("fail to db_util_close - [%d]", sqlret); + + return result; +} + +EXPORT_API badge_error_e badge_setting_db_get(const char *pkgname, const char *property, char **value) +{ + badge_error_e ret = BADGE_ERROR_NONE; + badge_error_e result = BADGE_ERROR_NONE; + sqlite3 *db = NULL; + char *sqlbuf = NULL; + sqlite3_stmt *stmt = NULL; + int sqlret; + const char *column = NULL; + + if (!pkgname) + return BADGE_ERROR_INVALID_DATA; + + if (!property) + return BADGE_ERROR_INVALID_DATA; + + if (!value) + return BADGE_ERROR_INVALID_DATA; + + column = _get_prop_column(property); + if (!column) + return BADGE_ERROR_INVALID_DATA; + + sqlret = db_util_open(SETTING_DB_FILE, &db, 0); + if (sqlret != SQLITE_OK || !db) { + ERR("fail to db_util_open - [%d]", sqlret); + return BADGE_ERROR_FROM_DB; + } + + ret = _is_record_exist(pkgname, db); + if (ret != BADGE_ERROR_ALREADY_EXIST) { + result = ret; + goto return_close_db; + } + + sqlbuf = sqlite3_mprintf("SELECT %s FROM %s " \ + "WHERE appid = %Q", + column, SETTING_DB_TABLE, pkgname); + if (!sqlbuf) { + ERR("fail to alloc query"); + result = BADGE_ERROR_NO_MEMORY; + goto return_close_db; + } + + sqlret = sqlite3_prepare_v2(db, sqlbuf, -1, &stmt, NULL); + if (sqlret != SQLITE_OK) { + ERR("fail to prepare %s - [%s]", + sqlbuf, sqlite3_errmsg(db)); + result = BADGE_ERROR_FROM_DB; + goto return_close_db; + } + + sqlret = sqlite3_step(stmt); + if (sqlret == SQLITE_ROW) { + int get_bytes = sqlite3_column_bytes(stmt, 0); + char *get_data = (char *)calloc(get_bytes + 1, sizeof(char)); + if (get_data != NULL) { + memcpy(get_data, sqlite3_column_text(stmt, 0), + get_bytes * sizeof(char)); + get_data[get_bytes] = '\0'; + *value = get_data; + } else { + ERR("fail to alloc query"); + result = BADGE_ERROR_NO_MEMORY; + goto return_close_db; + } + } + +return_close_db: + if (sqlbuf) + sqlite3_free(sqlbuf); + + if (stmt) + sqlite3_finalize(stmt); + + sqlret = db_util_close(db); + if (sqlret != SQLITE_OK) + WARN("fail to db_util_close - [%d]", sqlret); + + return result; +} + +EXPORT_API badge_error_e badge_setting_property_set(const char *pkgname, const char *property, const char *value) +{ + int ret = 0; + + if (!pkgname) + return BADGE_ERROR_INVALID_DATA; + + if (!property) + return BADGE_ERROR_INVALID_DATA; + + if (!value) + return BADGE_ERROR_INVALID_DATA; + + ret = badge_ipc_setting_property_set(pkgname, property, value); + if (ret != BADGE_ERROR_NONE) { + return ret; + } + + return BADGE_ERROR_NONE; +} + +EXPORT_API badge_error_e badge_setting_property_get(const char *pkgname, const char *property, char **value) +{ + int ret = 0; + + if (!pkgname) + return BADGE_ERROR_INVALID_DATA; + + if (!property) + return BADGE_ERROR_INVALID_DATA; + + if (!value) + return BADGE_ERROR_INVALID_DATA; + + ret = badge_ipc_setting_property_get(pkgname, property, value); + if (ret != BADGE_ERROR_NONE) { + return ret; + } + + return BADGE_ERROR_NONE; +} |