revert renaming of data2_str to data3_str, while this looks clearer at a first glance, it would mean to introduce much noise in the existing bindings and understandings

This commit is contained in:
B. Petersen
2020-05-25 12:58:21 +02:00
parent 2156c6cd7a
commit ec601a3381
3 changed files with 9 additions and 9 deletions

View File

@@ -3863,7 +3863,7 @@ void dc_event_emitter_unref(dc_event_emitter_t* emitter);
* Get the event-id from an event object. * Get the event-id from an event object.
* The event-id is one of the @ref DC_EVENT constants. * The event-id is one of the @ref DC_EVENT constants.
* There may be additional data belonging to an event, * There may be additional data belonging to an event,
* to get them, use dc_event_get_data1_int(), dc_event_get_data2_int() and dc_event_get_data3_str(). * to get them, use dc_event_get_data1_int(), dc_event_get_data2_int() and dc_event_get_data2_str().
* *
* @memberof dc_event_t * @memberof dc_event_t
* @param event Event object as returned from dc_get_next_event(). * @param event Event object as returned from dc_get_next_event().
@@ -3877,7 +3877,7 @@ int dc_event_get_id(dc_event_t* event);
* Get a data associated with an event object. * Get a data associated with an event object.
* The meaning of the data depends on the event-id * The meaning of the data depends on the event-id
* returned as @ref DC_EVENT constants by dc_event_get_id(). * returned as @ref DC_EVENT constants by dc_event_get_id().
* See also dc_event_get_data2_int() and dc_event_get_data3_str(). * See also dc_event_get_data2_int() and dc_event_get_data2_str().
* *
* @memberof dc_event_t * @memberof dc_event_t
* @param event Event object as returned from dc_get_next_event(). * @param event Event object as returned from dc_get_next_event().
@@ -3891,7 +3891,7 @@ int dc_event_get_data1_int(dc_event_t* event);
* Get a data associated with an event object. * Get a data associated with an event object.
* The meaning of the data depends on the event-id * The meaning of the data depends on the event-id
* returned as @ref DC_EVENT constants by dc_event_get_id(). * returned as @ref DC_EVENT constants by dc_event_get_id().
* See also dc_event_get_data2_int() and dc_event_get_data3_str(). * See also dc_event_get_data2_int() and dc_event_get_data2_str().
* *
* @memberof dc_event_t * @memberof dc_event_t
* @param event Event object as returned from dc_get_next_event(). * @param event Event object as returned from dc_get_next_event().
@@ -3909,11 +3909,11 @@ int dc_event_get_data2_int(dc_event_t* event);
* *
* @memberof dc_event_t * @memberof dc_event_t
* @param event Event object as returned from dc_get_next_event(). * @param event Event object as returned from dc_get_next_event().
* @return "data3" as a string, * @return "data2" as a string,
* the meaning depends on the event type associated with this event. * the meaning depends on the event type associated with this event.
* Once you're done with the string, you have to unref it using dc_unref_str(). * Once you're done with the string, you have to unref it using dc_unref_str().
*/ */
char* dc_event_get_data3_str(dc_event_t* event); char* dc_event_get_data2_str(dc_event_t* event);
/** /**
@@ -3934,7 +3934,7 @@ void dc_event_unref(dc_event_t* event);
* in events returned by dc_get_next_event(). * in events returned by dc_get_next_event().
* *
* Events typically come with some additional data, * Events typically come with some additional data,
* use dc_event_get_data1_int(), dc_event_get_data2_int() and dc_event_get_data3_str() to read this data. * use dc_event_get_data1_int(), dc_event_get_data2_int() and dc_event_get_data2_str() to read this data.
* The meaning of the data depends on the event. * The meaning of the data depends on the event.
* *
* @addtogroup DC_EVENT * @addtogroup DC_EVENT

View File

@@ -403,9 +403,9 @@ pub unsafe extern "C" fn dc_event_get_data2_int(event: *mut dc_event_t) -> libc:
} }
#[no_mangle] #[no_mangle]
pub unsafe extern "C" fn dc_event_get_data3_str(event: *mut dc_event_t) -> *mut libc::c_char { pub unsafe extern "C" fn dc_event_get_data2_str(event: *mut dc_event_t) -> *mut libc::c_char {
if event.is_null() { if event.is_null() {
eprintln!("ignoring careless call to dc_event_get_data3_str()"); eprintln!("ignoring careless call to dc_event_get_data2_str()");
return ptr::null_mut(); return ptr::null_mut();
} }

View File

@@ -172,7 +172,7 @@ class EventThread(threading.Thread):
# function which provides us signature info of an event call # function which provides us signature info of an event call
evt_name = deltachat.get_dc_event_name(evt) evt_name = deltachat.get_dc_event_name(evt)
if lib.dc_event_has_string_data(evt): if lib.dc_event_has_string_data(evt):
data2 = from_dc_charpointer(lib.dc_event_get_data3_str(event)) data2 = from_dc_charpointer(lib.dc_event_get_data2_str(event))
else: else:
data2 = lib.dc_event_get_data2_int(event) data2 = lib.dc_event_get_data2_int(event)