From 3e037f26a04cc3f04d1b042766433f6267104475 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Grisez?= Date: Fri, 13 Jan 2017 14:08:46 +0100 Subject: [PATCH] Add a header file declaring functions exclusive for automatic wrapper generators --- coreapi/chat.c | 2 +- coreapi/help/doxygen.dox | 6 +++ include/CMakeLists.txt | 1 + include/linphone/wrapper_utils.h | 61 ++++++++++++++++++++++++++++++ wrappers/cpp/class_header.mustache | 1 + 5 files changed, 70 insertions(+), 1 deletion(-) create mode 100644 include/linphone/wrapper_utils.h diff --git a/coreapi/chat.c b/coreapi/chat.c index e8cfe727e..04e5da6aa 100644 --- a/coreapi/chat.c +++ b/coreapi/chat.c @@ -916,7 +916,7 @@ void linphone_chat_room_send_message2(LinphoneChatRoom *cr, LinphoneChatMessage _linphone_chat_room_send_message(cr, msg); } -void linphone_chat_room_send_message_3(LinphoneChatRoom *cr, LinphoneChatMessage *msg) { +void linphone_chat_room_send_chat_message_2(LinphoneChatRoom *cr, LinphoneChatMessage *msg) { linphone_chat_message_ref(msg); _linphone_chat_room_send_message(cr, msg); } diff --git a/coreapi/help/doxygen.dox b/coreapi/help/doxygen.dox index 69d5dc896..db7af3a0b 100644 --- a/coreapi/help/doxygen.dox +++ b/coreapi/help/doxygen.dox @@ -463,3 +463,9 @@ I/lib/Could not find decoder for SILK */ +/** + * @defgroup wrapper Wrapper utilities + * These functions are used by automatic API wrapper generators and should not + * be used by C API users. + */ + diff --git a/include/CMakeLists.txt b/include/CMakeLists.txt index 879e2454d..95b530e2b 100644 --- a/include/CMakeLists.txt +++ b/include/CMakeLists.txt @@ -53,6 +53,7 @@ set(HEADER_FILES vcard.h xmlrpc.h im_encryption_engine.h + wrapper_utils.h # Deprecated header files linphonecore.h diff --git a/include/linphone/wrapper_utils.h b/include/linphone/wrapper_utils.h new file mode 100644 index 000000000..dd1acbafe --- /dev/null +++ b/include/linphone/wrapper_utils.h @@ -0,0 +1,61 @@ +/* +wrapper_utils.h +Copyright (C) 2017 Belledonne Communications SARL + +This program is free software; you can redistribute it and/or +modify it under the terms of the GNU General Public License +as published by the Free Software Foundation; either version 2 +of the License, or (at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +*/ + +/* + * That file declares functions that are used by automatic API wrapper generators. These + * should not be used by C API users. + */ + +#ifndef _WRAPPER_UTILS_H +#define _WRAPPER_UTILS_H + +#include "chat.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @addtogroup wrapper + * @{ + */ + +/** + * Send a message to peer member of this chat room. + * + * The state of the sending message will be notified via the callbacks defined in the #LinphoneChatMessageCbs object that can be obtained + * by calling linphone_chat_message_get_callbacks(). + * @note Unlike linphone_chat_room_send_chat_message(), that function only takes a reference on the #LinphoneChatMessage + * instead of totaly takes ownership on it. Thus, the #LinphoneChatMessage object must be released by the API user after calling + * that function. + * + * @param[in] cr A chat room. + * @param[in] msg The message to send. + */ +LINPHONE_PUBLIC void linphone_chat_room_send_chat_message_2(LinphoneChatRoom *cr, LinphoneChatMessage *msg); + +/** + * @} + */ + +#ifdef __cplusplus +} +#endif + +#endif // _WRAPPER_UTILS_H diff --git a/wrappers/cpp/class_header.mustache b/wrappers/cpp/class_header.mustache index 667e33cfd..2efad6547 100644 --- a/wrappers/cpp/class_header.mustache +++ b/wrappers/cpp/class_header.mustache @@ -17,6 +17,7 @@ #include "linphone/linphonecore.h" #include "linphone/linphone_tunnel.h" #include "linphone/linphonecore_utils.h" +#include "linphone/wrapper_utils.h" namespace linphone {