From 6c33483cd0e75eab94d4560b717e5a1eb2a77b25 Mon Sep 17 00:00:00 2001 From: "B. Petersen" Date: Fri, 24 Nov 2017 14:01:15 +0100 Subject: [PATCH] doxygen --- docs/html/annotated.html | 8 +- docs/html/classes.html | 4 +- docs/html/files.html | 31 +-- docs/html/functions.html | 22 +- docs/html/functions_func.html | 12 +- docs/html/functions_vars.html | 10 +- docs/html/mrarray_8h_source.html | 2 +- docs/html/mrchatlist_8h_source.html | 8 +- docs/html/mrlot_8h_source.html | 110 ++++++++++ docs/html/mrmailbox_8h_source.html | 4 +- docs/html/mrmsg_8h_source.html | 28 +-- docs/html/mrpoortext_8h_source.html | 9 +- docs/html/mrtools_8h_source.html | 2 +- docs/html/search/all_1.js | 22 +- docs/html/search/classes_0.js | 4 +- docs/html/search/functions_0.js | 10 +- docs/html/search/variables_0.js | 10 +- docs/html/structmrarray__t.html | 6 +- docs/html/structmrchatlist__t-members.html | 2 +- docs/html/structmrchatlist__t.html | 30 +-- docs/html/structmrlot__t-members.html | 105 +++++++++ docs/html/structmrlot__t.html | 241 +++++++++++++++++++++ docs/html/structmrmailbox__t.html | 2 +- docs/html/structmrmsg__t-members.html | 4 +- docs/html/structmrmsg__t.html | 40 ++-- 25 files changed, 593 insertions(+), 133 deletions(-) create mode 100644 docs/html/mrlot_8h_source.html create mode 100644 docs/html/structmrlot__t-members.html create mode 100644 docs/html/structmrlot__t.html diff --git a/docs/html/annotated.html b/docs/html/annotated.html index 94506d0e..49ee1ec3 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -87,13 +87,13 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Here are the classes, structs, unions and interfaces with brief descriptions:
- + - - - + + +
 Cmrarray_tAn object representing a simple array
 Cmrarray_tAn object containing a simple array
 Cmrchat_tAn object representing a single chat in memory
 Cmrchatlist_tAn object representing a single chatlist in memory
 Cmrcontact_tAn object representing a single contact in memory
 Cmrmailbox_tAn object representing a single mailbox
 Cmrmsg_tAn object representing a single message in memory
 Cmrpoortext_tAn object representing text with some attributes
 Cmrlot_tAn object containing a set of values
 Cmrmailbox_tAn object representing a single mailbox
 Cmrmsg_tAn object representing a single message in memory
diff --git a/docs/html/classes.html b/docs/html/classes.html index 860a680e..140e2e96 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -88,8 +88,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
M
- + +
  m  
-		mrchat_t   mrcontact_t   mrmsg_t   
mrchatlist_t   mrmailbox_t   mrpoortext_t   
mrchat_t   mrcontact_t   mrmailbox_t   
mrchatlist_t   mrlot_t   mrmsg_t   
mrarray_t   
diff --git a/docs/html/files.html b/docs/html/files.html index 6385789d..238c2e1d 100644 --- a/docs/html/files.html +++ b/docs/html/files.html @@ -101,21 +101,22 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');  mrkey.h  mrkeyring.h  mrloginparam.h - mrmailbox.h - mrmailbox_internal.h - mrmimefactory.h - mrmimeparser.h - mrmsg.h - mrosnative.h - mrparam.h - mrpgp.h - mrpoortext.h - mrsaxparser.h - mrsimplify.h - mrsmtp.h - mrsqlite3.h - mrstock.h - mrtools.h + mrlot.h + mrmailbox.h + mrmailbox_internal.h + mrmimefactory.h + mrmimeparser.h + mrmsg.h + mrosnative.h + mrparam.h + mrpgp.h + mrpoortext.h + mrsaxparser.h + mrsimplify.h + mrsmtp.h + mrsqlite3.h + mrstock.h + mrtools.h diff --git a/docs/html/functions.html b/docs/html/functions.html index 3f7fd77f..bd6cc5b7 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -142,19 +142,19 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); , mrcontact_t
  • m_state -: mrpoortext_t +: mrlot_t
  • m_text1 -: mrpoortext_t +: mrlot_t
  • m_text1_meaning -: mrpoortext_t +: mrlot_t
  • m_text2 -: mrpoortext_t +: mrlot_t
  • m_timestamp -: mrpoortext_t +: mrlot_t
  • m_to_id : mrmsg_t @@ -196,7 +196,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : mrchatlist_t
  • mrchatlist_get_summary() -: mrchatlist_t +: mrchatlist_t
  • mrchatlist_unref() : mrchatlist_t @@ -222,6 +222,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • mrcontact_unref() : mrcontact_t
    • +
  • mrlot_unref() +: mrlot_t +
  • mrmailbox_add_address_book() : mrmailbox_t
    • @@ -442,7 +445,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : mrmsg_t
  • mrmsg_get_mediainfo() -: mrmsg_t +: mrmsg_t
  • mrmsg_get_showpadlock() : mrmsg_t @@ -451,7 +454,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : mrmsg_t
  • mrmsg_get_summary() -: mrmsg_t +: mrmsg_t
  • mrmsg_get_summarytext() : mrmsg_t @@ -486,9 +489,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • mrmsg_unref() : mrmsg_t
    • -
  • mrpoortext_unref() -: mrpoortext_t -
    • diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html index 2642fb80..a1a2361b 100644 --- a/docs/html/functions_func.html +++ b/docs/html/functions_func.html @@ -128,7 +128,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : mrchatlist_t
  • mrchatlist_get_summary() -: mrchatlist_t +: mrchatlist_t
  • mrchatlist_unref() : mrchatlist_t @@ -154,6 +154,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • mrcontact_unref() : mrcontact_t
    • +
  • mrlot_unref() +: mrlot_t +
  • mrmailbox_add_address_book() : mrmailbox_t
    • @@ -371,7 +374,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : mrmsg_t
  • mrmsg_get_mediainfo() -: mrmsg_t +: mrmsg_t
  • mrmsg_get_showpadlock() : mrmsg_t @@ -380,7 +383,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); : mrmsg_t
  • mrmsg_get_summary() -: mrmsg_t +: mrmsg_t
  • mrmsg_get_summarytext() : mrmsg_t @@ -415,9 +418,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • mrmsg_unref() : mrmsg_t
    • -
  • mrpoortext_unref() -: mrpoortext_t -
    • diff --git a/docs/html/functions_vars.html b/docs/html/functions_vars.html index bd514adc..340efd2a 100644 --- a/docs/html/functions_vars.html +++ b/docs/html/functions_vars.html @@ -135,19 +135,19 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); , mrcontact_t
  • m_state -: mrpoortext_t +: mrlot_t
  • m_text1 -: mrpoortext_t +: mrlot_t
  • m_text1_meaning -: mrpoortext_t +: mrlot_t
  • m_text2 -: mrpoortext_t +: mrlot_t
  • m_timestamp -: mrpoortext_t +: mrlot_t
  • m_to_id : mrmsg_t diff --git a/docs/html/mrarray_8h_source.html b/docs/html/mrarray_8h_source.html index f3169b43..19b22013 100644 --- a/docs/html/mrarray_8h_source.html +++ b/docs/html/mrarray_8h_source.html @@ -89,7 +89,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    mrarray.h
    -
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 #ifndef __MRARRAY_H__
    24 #define __MRARRAY_H__
    25 #ifdef __cplusplus
    26 extern "C" {
    27 #endif
    28 
    29 
    30 typedef struct mrmailbox_t mrmailbox_t;
    31 
    32 
    39 typedef struct mrarray_t
    40 {
    41  mrmailbox_t* m_mailbox;
    44  size_t m_allocated;
    45  size_t m_count;
    46  uintptr_t* m_array;
    47 } mrarray_t;
    48 
    49 
    50 mrarray_t* mrarray_new (mrmailbox_t*, size_t initsize);
    51 void mrarray_empty (mrarray_t*);
    52 void mrarray_unref (mrarray_t*);
    53 
    54 void mrarray_add_id (mrarray_t*, uint32_t id);
    55 
    56 size_t mrarray_get_cnt (mrarray_t*);
    57 uint32_t mrarray_get_id (mrarray_t*, size_t index);
    58 int mrarray_search_id (mrarray_t*, uint32_t needle, size_t* indx);
    59 
    60 #ifdef __cplusplus
    61 } /* /extern "C" */
    62 #endif
    63 #endif /* __MRARRAY_H__ */
    64 
    mrarray_t
    An object representing a simple array.
    Definition: mrarray.h:39
    +
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 #ifndef __MRARRAY_H__
    24 #define __MRARRAY_H__
    25 #ifdef __cplusplus
    26 extern "C" {
    27 #endif
    28 
    29 
    30 typedef struct mrmailbox_t mrmailbox_t;
    31 
    32 
    39 typedef struct mrarray_t
    40 {
    41  mrmailbox_t* m_mailbox;
    44  size_t m_allocated;
    45  size_t m_count;
    46  uintptr_t* m_array;
    47 } mrarray_t;
    48 
    49 
    50 mrarray_t* mrarray_new (mrmailbox_t*, size_t initsize);
    51 void mrarray_empty (mrarray_t*);
    52 void mrarray_unref (mrarray_t*);
    53 
    54 void mrarray_add_id (mrarray_t*, uint32_t id);
    55 
    56 size_t mrarray_get_cnt (mrarray_t*);
    57 uint32_t mrarray_get_id (mrarray_t*, size_t index);
    58 int mrarray_search_id (mrarray_t*, uint32_t needle, size_t* indx);
    59 
    60 #ifdef __cplusplus
    61 } /* /extern "C" */
    62 #endif
    63 #endif /* __MRARRAY_H__ */
    64 
    mrarray_t
    An object containing a simple array.
    Definition: mrarray.h:39
    mrarray_t::mrarray_get_cnt
    size_t mrarray_get_cnt(mrarray_t *array)
    Find out the number of items in an array.
    Definition: mrarray.c:136
    mrmailbox_t
    An object representing a single mailbox.
    Definition: mrmailbox.h:184
    mrarray_t::mrarray_unref
    void mrarray_unref(mrarray_t *array)
    Free an array object.
    Definition: mrarray.c:67
    diff --git a/docs/html/mrchatlist_8h_source.html b/docs/html/mrchatlist_8h_source.html index 86939e2b..2f043053 100644 --- a/docs/html/mrchatlist_8h_source.html +++ b/docs/html/mrchatlist_8h_source.html @@ -89,16 +89,16 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    mrchatlist.h
    -
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 #ifndef __MRCHATLIST_H__
    24 #define __MRCHATLIST_H__
    25 #ifdef __cplusplus
    26 extern "C" {
    27 #endif
    28 
    29 
    30 typedef struct mrmailbox_t mrmailbox_t;
    31 typedef struct mrpoortext_t mrpoortext_t;
    32 typedef struct mrchat_t mrchat_t;
    33 typedef struct mrarray_t mrarray_t;
    34 
    35 
    43 typedef struct mrchatlist_t
    44 {
    45  mrmailbox_t* m_mailbox;
    48  #define MR_CHATLIST_IDS_PER_RESULT 2
    49  size_t m_cnt;
    50  mrarray_t* m_chatNlastmsg_ids;
    51 } mrchatlist_t;
    52 
    53 
    54 mrchatlist_t* mrchatlist_new (mrmailbox_t*);
    55 void mrchatlist_empty (mrchatlist_t*);
    56 void mrchatlist_unref (mrchatlist_t*);
    57 size_t mrchatlist_get_cnt (mrchatlist_t*);
    58 uint32_t mrchatlist_get_chat_id (mrchatlist_t*, size_t index);
    59 uint32_t mrchatlist_get_msg_id (mrchatlist_t*, size_t index);
    60 mrpoortext_t* mrchatlist_get_summary (mrchatlist_t*, size_t index, mrchat_t*);
    61 
    62 /* library-internal */
    63 int mrchatlist_load_from_db__ (mrchatlist_t*, int listflags, const char* query);
    64 
    65 
    66 #ifdef __cplusplus
    67 } /* /extern "C" */
    68 #endif
    69 #endif /* __MRCHATLIST_H__ */
    mrchatlist_t::m_mailbox
    mrmailbox_t * m_mailbox
    The mailbox, the chatlist belongs to.
    Definition: mrchatlist.h:45
    -
    mrarray_t
    An object representing a simple array.
    Definition: mrarray.h:39
    +
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 #ifndef __MRCHATLIST_H__
    24 #define __MRCHATLIST_H__
    25 #ifdef __cplusplus
    26 extern "C" {
    27 #endif
    28 
    29 
    30 typedef struct mrmailbox_t mrmailbox_t;
    31 typedef struct mrlot_t mrlot_t;
    32 typedef struct mrchat_t mrchat_t;
    33 typedef struct mrarray_t mrarray_t;
    34 
    35 
    43 typedef struct mrchatlist_t
    44 {
    45  mrmailbox_t* m_mailbox;
    48  #define MR_CHATLIST_IDS_PER_RESULT 2
    49  size_t m_cnt;
    50  mrarray_t* m_chatNlastmsg_ids;
    51 } mrchatlist_t;
    52 
    53 
    54 mrchatlist_t* mrchatlist_new (mrmailbox_t*);
    55 void mrchatlist_empty (mrchatlist_t*);
    56 void mrchatlist_unref (mrchatlist_t*);
    57 size_t mrchatlist_get_cnt (mrchatlist_t*);
    58 uint32_t mrchatlist_get_chat_id (mrchatlist_t*, size_t index);
    59 uint32_t mrchatlist_get_msg_id (mrchatlist_t*, size_t index);
    60 mrlot_t* mrchatlist_get_summary (mrchatlist_t*, size_t index, mrchat_t*);
    61 
    62 /* library-internal */
    63 int mrchatlist_load_from_db__ (mrchatlist_t*, int listflags, const char* query);
    64 
    65 
    66 #ifdef __cplusplus
    67 } /* /extern "C" */
    68 #endif
    69 #endif /* __MRCHATLIST_H__ */
    mrchatlist_t::m_mailbox
    mrmailbox_t * m_mailbox
    The mailbox, the chatlist belongs to.
    Definition: mrchatlist.h:45
    +
    mrarray_t
    An object containing a simple array.
    Definition: mrarray.h:39
    mrchatlist_t
    An object representing a single chatlist in memory.
    Definition: mrchatlist.h:43
    -
    mrchatlist_t::mrchatlist_get_summary
    mrpoortext_t * mrchatlist_get_summary(mrchatlist_t *chatlist, size_t index, mrchat_t *chat)
    Get a summary for a chatlist index.
    Definition: mrchatlist.c:189
    mrmailbox_t
    An object representing a single mailbox.
    Definition: mrmailbox.h:184
    mrchatlist_t::mrchatlist_get_msg_id
    uint32_t mrchatlist_get_msg_id(mrchatlist_t *chatlist, size_t index)
    Get a single message ID of a chatlist.
    Definition: mrchatlist.c:149
    -
    mrpoortext_t
    An object representing text with some attributes.
    Definition: mrpoortext.h:35
    +
    mrlot_t
    An object containing a set of values.
    Definition: mrlot.h:36
    mrchatlist_t::mrchatlist_get_cnt
    size_t mrchatlist_get_cnt(mrchatlist_t *chatlist)
    Find out the number of chats in a chatlist.
    Definition: mrchatlist.c:101
    mrchatlist_t::mrchatlist_get_chat_id
    uint32_t mrchatlist_get_chat_id(mrchatlist_t *chatlist, size_t index)
    Get a single chat ID of a chatlist.
    Definition: mrchatlist.c:125
    mrchatlist_t::mrchatlist_unref
    void mrchatlist_unref(mrchatlist_t *chatlist)
    Free a chatlist object.
    Definition: mrchatlist.c:62
    +
    mrchatlist_t::mrchatlist_get_summary
    mrlot_t * mrchatlist_get_summary(mrchatlist_t *chatlist, size_t index, mrchat_t *chat)
    Get a summary for a chatlist index.
    Definition: mrchatlist.c:187
    mrchat_t
    An object representing a single chat in memory.
    Definition: mrchat.h:39
    diff --git a/docs/html/mrlot_8h_source.html b/docs/html/mrlot_8h_source.html new file mode 100644 index 00000000..7bde041e --- /dev/null +++ b/docs/html/mrlot_8h_source.html @@ -0,0 +1,110 @@ + + + + + + +Delta Chat Core C-API: /home/bpetersen/projects/deltachat-core/src/mrlot.h Source File + + + + + + + + + + + +
    +
    + + + + + + +
    +
    Delta Chat Core C-API +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + + +
    +
    +
    +
    mrlot.h
    +
    +
    +
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 #ifndef __MRLOT_H__
    24 #define __MRLOT_H__
    25 #ifdef __cplusplus
    26 extern "C" {
    27 #endif
    28 
    29 
    36 typedef struct mrlot_t
    37 {
    38  int m_text1_meaning;
    39  char* m_text1;
    40  char* m_text2;
    41  time_t m_timestamp;
    42  int m_state;
    43 } mrlot_t;
    44 
    45 
    46 #define MR_TEXT1_DRAFT 1
    47 #define MR_TEXT1_USERNAME 2
    48 #define MR_TEXT1_SELF 3
    49 
    50 
    51 mrlot_t* mrlot_new ();
    52 void mrlot_empty (mrlot_t*);
    53 void mrlot_unref (mrlot_t*);
    54 
    55 
    56 /* library-internal */
    57 #define MR_SUMMARY_CHARACTERS 160 /* in practice, the user additionally cuts the string himself pixel-accurate */
    58 void mrlot_fill (mrlot_t*, const mrmsg_t*, const mrchat_t*, const mrcontact_t*);
    59 
    60 
    61 #ifdef __cplusplus
    62 } /* /extern "C" */
    63 #endif
    64 #endif /* __MRLOT_H__ */
    mrcontact_t
    An object representing a single contact in memory.
    Definition: mrcontact.h:38
    +
    mrlot_t::m_text2
    char * m_text2
    The meaning of this string is defined by the creator of the object.
    Definition: mrlot.h:40
    +
    mrlot_t::m_state
    int m_state
    The meaning of this value is defined by the creator of the object.
    Definition: mrlot.h:42
    +
    mrlot_t::m_text1_meaning
    int m_text1_meaning
    The meaning of this value is defined by the creator of the object.
    Definition: mrlot.h:38
    +
    mrmsg_t
    An object representing a single message in memory.
    Definition: mrmsg.h:40
    +
    mrlot_t
    An object containing a set of values.
    Definition: mrlot.h:36
    +
    mrlot_t::mrlot_unref
    void mrlot_unref(mrlot_t *set)
    Frees an object containing a set of parameters.
    Definition: mrlot.c:52
    +
    mrlot_t::m_timestamp
    time_t m_timestamp
    The meaning of this value is defined by the creator of the object.
    Definition: mrlot.h:41
    +
    mrlot_t::m_text1
    char * m_text1
    The meaning of this string is defined by the creator of the object.
    Definition: mrlot.h:39
    +
    mrchat_t
    An object representing a single chat in memory.
    Definition: mrchat.h:39
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/mrmailbox_8h_source.html b/docs/html/mrmailbox_8h_source.html index c72b4b43..52555f8e 100644 --- a/docs/html/mrmailbox_8h_source.html +++ b/docs/html/mrmailbox_8h_source.html @@ -89,7 +89,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    mrmailbox.h
    -
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 #ifndef __MRMAILBOX_H__
    24 #define __MRMAILBOX_H__
    25 #ifdef __cplusplus
    26 extern "C" {
    27 #endif
    28 
    29 
    30 #define MR_VERSION_MAJOR 0
    31 #define MR_VERSION_MINOR 9
    32 #define MR_VERSION_REVISION 10
    33 
    34 
    140 #include <pthread.h>
    141 #include <libetpan/libetpan.h> /* defines uint16_t */
    142 #include "mrarray.h"
    143 #include "mrchatlist.h"
    144 #include "mrchat.h"
    145 #include "mrmsg.h"
    146 #include "mrcontact.h"
    147 #include "mrpoortext.h"
    148 #include "mrparam.h"
    149 #include "mrevent.h"
    150 
    151 typedef struct mrmailbox_t mrmailbox_t;
    152 typedef struct mrimap_t mrimap_t;
    153 typedef struct mrsmtp_t mrsmtp_t;
    154 typedef struct mrsqlite3_t mrsqlite3_t;
    155 typedef struct mrjob_t mrjob_t;
    156 typedef struct mrmimeparser_t mrmimeparser_t;
    157 
    158 
    174 typedef uintptr_t (*mrmailboxcb_t) (mrmailbox_t*, int event, uintptr_t data1, uintptr_t data2);
    175 
    176 
    184 typedef struct mrmailbox_t
    185 {
    186  void* m_userdata;
    187  char* m_dbfile;
    188  char* m_blobdir;
    191  mrsqlite3_t* m_sql;
    192  mrimap_t* m_imap;
    193  mrsmtp_t* m_smtp;
    195  pthread_t m_job_thread;
    196  pthread_cond_t m_job_cond;
    197  pthread_mutex_t m_job_condmutex;
    198  int m_job_condflag;
    199  int m_job_do_exit;
    201  mrmailboxcb_t m_cb;
    203  char* m_os_name;
    205  uint32_t m_cmdline_sel_chat_id;
    207  int m_wake_lock;
    208  pthread_mutex_t m_wake_lock_critical;
    210  int m_e2ee_enabled;
    212  #define MR_LOG_RINGBUF_SIZE 200
    213  pthread_mutex_t m_log_ringbuf_critical;
    214  char* m_log_ringbuf[MR_LOG_RINGBUF_SIZE];
    216  time_t m_log_ringbuf_times[MR_LOG_RINGBUF_SIZE];
    218  int m_log_ringbuf_pos;
    220 } mrmailbox_t;
    221 
    222 
    223 /* create/open/connect */
    224 mrmailbox_t* mrmailbox_new (mrmailboxcb_t, void* userdata, const char* os_name);
    225 void mrmailbox_unref (mrmailbox_t*);
    226 
    227 int mrmailbox_open (mrmailbox_t*, const char* dbfile, const char* blobdir);
    228 void mrmailbox_close (mrmailbox_t*);
    229 int mrmailbox_is_open (const mrmailbox_t*);
    230 
    231 int mrmailbox_set_config (mrmailbox_t*, const char* key, const char* value);
    232 char* mrmailbox_get_config (mrmailbox_t*, const char* key, const char* def);
    233 int mrmailbox_set_config_int (mrmailbox_t*, const char* key, int32_t value);
    234 int32_t mrmailbox_get_config_int (mrmailbox_t*, const char* key, int32_t def);
    235 char* mrmailbox_get_version_str (void);
    236 
    237 int mrmailbox_configure_and_connect(mrmailbox_t*);
    238 void mrmailbox_configure_cancel (mrmailbox_t*);
    239 int mrmailbox_is_configured (mrmailbox_t*);
    240 
    241 void mrmailbox_connect (mrmailbox_t*);
    242 void mrmailbox_disconnect (mrmailbox_t*);
    243 
    244 char* mrmailbox_get_info (mrmailbox_t*);
    245 
    246 
    247 /* Handle chatlists */
    248 #define MR_GCL_ARCHIVED_ONLY 0x01
    249 #define MR_GCL_NO_SPECIALS 0x02
    250 mrchatlist_t* mrmailbox_get_chatlist (mrmailbox_t*, int flags, const char* query);
    251 
    252 
    253 /* Handle chats */
    254 uint32_t mrmailbox_create_chat_by_contact_id (mrmailbox_t*, uint32_t contact_id);
    255 uint32_t mrmailbox_get_chat_id_by_contact_id (mrmailbox_t*, uint32_t contact_id);
    256 
    257 uint32_t mrmailbox_send_text_msg (mrmailbox_t*, uint32_t chat_id, const char* text_to_send);
    258 uint32_t mrmailbox_send_image_msg (mrmailbox_t*, uint32_t chat_id, const char* file, const char* filemime, int width, int height);
    259 uint32_t mrmailbox_send_video_msg (mrmailbox_t*, uint32_t chat_id, const char* file, const char* filemime, int width, int height, int duration);
    260 uint32_t mrmailbox_send_voice_msg (mrmailbox_t*, uint32_t chat_id, const char* file, const char* filemime, int duration);
    261 uint32_t mrmailbox_send_audio_msg (mrmailbox_t*, uint32_t chat_id, const char* file, const char* filemime, int duration, const char* author, const char* trackname);
    262 uint32_t mrmailbox_send_file_msg (mrmailbox_t*, uint32_t chat_id, const char* file, const char* filemime);
    263 uint32_t mrmailbox_send_vcard_msg (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    264 void mrmailbox_set_draft (mrmailbox_t*, uint32_t chat_id, const char*);
    265 
    266 #define MR_GCM_ADDDAYMARKER 0x01
    267 mrarray_t* mrmailbox_get_chat_msgs (mrmailbox_t*, uint32_t chat_id, uint32_t flags, uint32_t marker1before);
    268 int mrmailbox_get_total_msg_count (mrmailbox_t*, uint32_t chat_id);
    269 int mrmailbox_get_fresh_msg_count (mrmailbox_t*, uint32_t chat_id);
    270 mrarray_t* mrmailbox_get_fresh_msgs (mrmailbox_t*);
    271 void mrmailbox_marknoticed_chat (mrmailbox_t*, uint32_t chat_id);
    272 mrarray_t* mrmailbox_get_chat_media (mrmailbox_t*, uint32_t chat_id, int msg_type, int or_msg_type);
    273 uint32_t mrmailbox_get_next_media (mrmailbox_t*, uint32_t curr_msg_id, int dir);
    274 
    275 void mrmailbox_archive_chat (mrmailbox_t*, uint32_t chat_id, int archive);
    276 void mrmailbox_delete_chat (mrmailbox_t*, uint32_t chat_id);
    277 
    278 mrarray_t* mrmailbox_get_chat_contacts (mrmailbox_t*, uint32_t chat_id);
    279 mrarray_t* mrmailbox_search_msgs (mrmailbox_t*, uint32_t chat_id, const char* query);
    280 
    281 mrchat_t* mrmailbox_get_chat (mrmailbox_t*, uint32_t chat_id);
    282 
    283 
    284 /* Handle group chats */
    285 uint32_t mrmailbox_create_group_chat (mrmailbox_t*, const char* name);
    286 int mrmailbox_is_contact_in_chat (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    287 int mrmailbox_add_contact_to_chat (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    288 int mrmailbox_remove_contact_from_chat (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    289 int mrmailbox_set_chat_name (mrmailbox_t*, uint32_t chat_id, const char* name);
    290 int mrmailbox_set_chat_profile_image (mrmailbox_t*, uint32_t chat_id, const char* image);
    291 
    292 
    293 /* Handle messages */
    294 char* mrmailbox_get_msg_info (mrmailbox_t*, uint32_t msg_id);
    295 void mrmailbox_delete_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt);
    296 void mrmailbox_forward_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt, uint32_t chat_id);
    297 void mrmailbox_marknoticed_contact (mrmailbox_t*, uint32_t contact_id);
    298 void mrmailbox_markseen_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt);
    299 void mrmailbox_star_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt, int star);
    300 mrmsg_t* mrmailbox_get_msg (mrmailbox_t*, uint32_t msg_id);
    301 
    302 
    303 /* Handle contacts */
    304 uint32_t mrmailbox_create_contact (mrmailbox_t*, const char* name, const char* addr);
    305 int mrmailbox_add_address_book (mrmailbox_t*, const char*);
    306 mrarray_t* mrmailbox_get_known_contacts (mrmailbox_t*, const char* query);
    307 int mrmailbox_get_blocked_count (mrmailbox_t*);
    308 mrarray_t* mrmailbox_get_blocked_contacts (mrmailbox_t*);
    309 void mrmailbox_block_contact (mrmailbox_t*, uint32_t contact_id, int block);
    310 char* mrmailbox_get_contact_encrinfo (mrmailbox_t*, uint32_t contact_id);
    311 int mrmailbox_delete_contact (mrmailbox_t*, uint32_t contact_id);
    312 mrcontact_t* mrmailbox_get_contact (mrmailbox_t*, uint32_t contact_id);
    313 
    314 
    315 /* Import/export and Tools */
    316 #define MR_IMEX_CANCEL 0
    317 #define MR_IMEX_EXPORT_SELF_KEYS 1 /* param1 is a directory where the keys are written to */
    318 #define MR_IMEX_IMPORT_SELF_KEYS 2 /* param1 is a directory where the keys are searched in and read from */
    319 #define MR_IMEX_EXPORT_BACKUP 11 /* param1 is a directory where the backup is written to */
    320 #define MR_IMEX_IMPORT_BACKUP 12 /* param1 is the file with the backup to import */
    321 #define MR_IMEX_EXPORT_SETUP_MESSAGE 20 /* param1 is a directory where the setup file is written to */
    322 #define MR_BAK_PREFIX "delta-chat"
    323 #define MR_BAK_SUFFIX "bak"
    324 void mrmailbox_imex (mrmailbox_t*, int what, const char* param1, const char* setup_code);
    325 char* mrmailbox_imex_has_backup (mrmailbox_t*, const char* dir);
    326 int mrmailbox_check_password (mrmailbox_t*, const char* pw);
    327 char* mrmailbox_create_setup_code (mrmailbox_t*);
    328 void mrmailbox_heartbeat (mrmailbox_t*);
    329 
    330 
    331 /* logging */
    332 void mrmailbox_log_error (mrmailbox_t*, int code, const char* msg, ...);
    333 void mrmailbox_log_error_if (int* condition, mrmailbox_t*, int code, const char* msg, ...);
    334 void mrmailbox_log_warning (mrmailbox_t*, int code, const char* msg, ...);
    335 void mrmailbox_log_info (mrmailbox_t*, int code, const char* msg, ...);
    336 void mrmailbox_log_vprintf (mrmailbox_t*, int event, int code, const char* msg, va_list);
    337 int mrmailbox_get_thread_index (void);
    338 
    339 
    340 /* error codes */
    341 #define MR_ERR_SELF_NOT_IN_GROUP 1
    342 #define MR_ERR_NONETWORK 2
    343 
    344 
    345 /* deprecated functions */
    346 int mrchat_set_draft (mrchat_t*, const char* msg); /* deprecated - use mrmailbox_set_draft() instead */
    347 
    348 
    349 /* library-internal */
    350 uint32_t mrmailbox_send_msg_object (mrmailbox_t*, uint32_t chat_id, mrmsg_t*);
    351 void mrmailbox_connect_to_imap (mrmailbox_t*, mrjob_t*);
    352 void mrmailbox_wake_lock (mrmailbox_t*);
    353 void mrmailbox_wake_unlock (mrmailbox_t*);
    354 int mrmailbox_poke_eml_file (mrmailbox_t*, const char* file);
    355 int mrmailbox_is_reply_to_known_message__ (mrmailbox_t*, mrmimeparser_t*);
    356 int mrmailbox_is_reply_to_messenger_message__ (mrmailbox_t*, mrmimeparser_t*);
    357 time_t mrmailbox_correct_bad_timestamp__ (mrmailbox_t* ths, uint32_t chat_id, uint32_t from_id, time_t desired_timestamp, int is_fresh_msg);
    358 void mrmailbox_add_or_lookup_contacts_by_mailbox_list__(mrmailbox_t* ths, struct mailimf_mailbox_list* mb_list, int origin, mrarray_t* ids, int* check_self);
    359 void mrmailbox_add_or_lookup_contacts_by_address_list__(mrmailbox_t* ths, struct mailimf_address_list* adr_list, int origin, mrarray_t* ids, int* check_self);
    360 int mrmailbox_get_archived_count__ (mrmailbox_t*);
    361 int mrmailbox_reset_tables (mrmailbox_t*, int bits); /* reset tables but leaves server configuration, 1=jobs, 2=e2ee, 8=rest but server config */
    362 size_t mrmailbox_get_real_contact_cnt__ (mrmailbox_t*);
    363 uint32_t mrmailbox_add_or_lookup_contact__ (mrmailbox_t*, const char* display_name /*can be NULL*/, const char* addr_spec, int origin, int* sth_modified);
    364 int mrmailbox_get_contact_origin__ (mrmailbox_t*, uint32_t id, int* ret_blocked);
    365 int mrmailbox_is_contact_blocked__ (mrmailbox_t*, uint32_t id);
    366 int mrmailbox_real_contact_exists__ (mrmailbox_t*, uint32_t id);
    367 int mrmailbox_contact_addr_equals__ (mrmailbox_t*, uint32_t contact_id, const char* other_addr);
    368 void mrmailbox_scaleup_contact_origin__ (mrmailbox_t*, uint32_t contact_id, int origin);
    369 void mrmailbox_unarchive_chat__ (mrmailbox_t*, uint32_t chat_id);
    370 size_t mrmailbox_get_chat_cnt__ (mrmailbox_t*);
    371 uint32_t mrmailbox_create_or_lookup_nchat_by_contact_id__ (mrmailbox_t*, uint32_t contact_id);
    372 uint32_t mrmailbox_lookup_real_nchat_by_contact_id__ (mrmailbox_t*, uint32_t contact_id);
    373 int mrmailbox_get_total_msg_count__ (mrmailbox_t*, uint32_t chat_id);
    374 int mrmailbox_get_fresh_msg_count__ (mrmailbox_t*, uint32_t chat_id);
    375 uint32_t mrmailbox_get_last_deaddrop_fresh_msg__ (mrmailbox_t*);
    376 void mrmailbox_send_msg_to_smtp (mrmailbox_t*, mrjob_t*);
    377 void mrmailbox_send_msg_to_imap (mrmailbox_t*, mrjob_t*);
    378 int mrmailbox_add_contact_to_chat__ (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    379 int mrmailbox_is_contact_in_chat__ (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    380 int mrmailbox_get_chat_contact_count__ (mrmailbox_t*, uint32_t chat_id);
    381 int mrmailbox_group_explicitly_left__ (mrmailbox_t*, const char* grpid);
    382 void mrmailbox_set_group_explicitly_left__ (mrmailbox_t*, const char* grpid);
    383 size_t mrmailbox_get_real_msg_cnt__ (mrmailbox_t*); /* the number of messages assigned to real chat (!=deaddrop, !=trash) */
    384 size_t mrmailbox_get_deaddrop_msg_cnt__ (mrmailbox_t*);
    385 int mrmailbox_rfc724_mid_cnt__ (mrmailbox_t*, const char* rfc724_mid);
    386 int mrmailbox_rfc724_mid_exists__ (mrmailbox_t*, const char* rfc724_mid, char** ret_server_folder, uint32_t* ret_server_uid);
    387 void mrmailbox_update_server_uid__ (mrmailbox_t*, const char* rfc724_mid, const char* server_folder, uint32_t server_uid);
    388 void mrmailbox_update_msg_chat_id__ (mrmailbox_t*, uint32_t msg_id, uint32_t chat_id);
    389 void mrmailbox_update_msg_state__ (mrmailbox_t*, uint32_t msg_id, int state);
    390 void mrmailbox_delete_msg_on_imap (mrmailbox_t* mailbox, mrjob_t* job);
    391 int mrmailbox_mdn_from_ext__ (mrmailbox_t*, uint32_t from_id, const char* rfc724_mid, uint32_t* ret_chat_id, uint32_t* ret_msg_id); /* returns 1 if an event should be send */
    392 void mrmailbox_send_mdn (mrmailbox_t*, mrjob_t* job);
    393 void mrmailbox_markseen_msg_on_imap (mrmailbox_t* mailbox, mrjob_t* job);
    394 void mrmailbox_markseen_mdn_on_imap (mrmailbox_t* mailbox, mrjob_t* job);
    395 
    396 
    397 /* library private: end-to-end-encryption */
    398 #define MR_E2EE_DEFAULT_ENABLED 1
    399 #define MR_MDNS_DEFAULT_ENABLED 1
    400 
    401 typedef struct mrmailbox_e2ee_helper_t {
    402  int m_encryption_successfull;
    403  void* m_cdata_to_free;
    404 } mrmailbox_e2ee_helper_t;
    405 
    406 void mrmailbox_e2ee_encrypt (mrmailbox_t*, const clist* recipients_addr, int e2ee_guaranteed, int encrypt_to_self, struct mailmime* in_out_message, mrmailbox_e2ee_helper_t*);
    407 int mrmailbox_e2ee_decrypt (mrmailbox_t*, struct mailmime* in_out_message, int* ret_validation_errors); /* returns 1 if sth. was decrypted, 0 in other cases */
    408 void mrmailbox_e2ee_thanks (mrmailbox_e2ee_helper_t*); /* frees data referenced by "mailmime" but not freed by mailmime_free(). After calling mre2ee_unhelp(), in_out_message cannot be used any longer! */
    409 int mrmailbox_ensure_secret_key_exists (mrmailbox_t*); /* makes sure, the private key exists, needed only for exporting keys and the case no message was sent before */
    410 
    411 
    412 #ifdef __cplusplus
    413 } /* /extern "C" */
    414 #endif
    415 #endif /* __MRMAILBOX_H__ */
    mrmailbox_t::mrmailbox_add_address_book
    int mrmailbox_add_address_book(mrmailbox_t *mailbox, const char *adr_book)
    Add a number of contacts.
    Definition: mrmailbox.c:4337
    +
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 #ifndef __MRMAILBOX_H__
    24 #define __MRMAILBOX_H__
    25 #ifdef __cplusplus
    26 extern "C" {
    27 #endif
    28 
    29 
    30 #define MR_VERSION_MAJOR 0
    31 #define MR_VERSION_MINOR 9
    32 #define MR_VERSION_REVISION 10
    33 
    34 
    140 #include <pthread.h>
    141 #include <libetpan/libetpan.h> /* defines uint16_t */
    142 #include "mrarray.h"
    143 #include "mrchatlist.h"
    144 #include "mrchat.h"
    145 #include "mrmsg.h"
    146 #include "mrcontact.h"
    147 #include "mrlot.h"
    148 #include "mrparam.h"
    149 #include "mrevent.h"
    150 
    151 typedef struct mrmailbox_t mrmailbox_t;
    152 typedef struct mrimap_t mrimap_t;
    153 typedef struct mrsmtp_t mrsmtp_t;
    154 typedef struct mrsqlite3_t mrsqlite3_t;
    155 typedef struct mrjob_t mrjob_t;
    156 typedef struct mrmimeparser_t mrmimeparser_t;
    157 
    158 
    174 typedef uintptr_t (*mrmailboxcb_t) (mrmailbox_t*, int event, uintptr_t data1, uintptr_t data2);
    175 
    176 
    184 typedef struct mrmailbox_t
    185 {
    186  void* m_userdata;
    187  char* m_dbfile;
    188  char* m_blobdir;
    191  mrsqlite3_t* m_sql;
    192  mrimap_t* m_imap;
    193  mrsmtp_t* m_smtp;
    195  pthread_t m_job_thread;
    196  pthread_cond_t m_job_cond;
    197  pthread_mutex_t m_job_condmutex;
    198  int m_job_condflag;
    199  int m_job_do_exit;
    201  mrmailboxcb_t m_cb;
    203  char* m_os_name;
    205  uint32_t m_cmdline_sel_chat_id;
    207  int m_wake_lock;
    208  pthread_mutex_t m_wake_lock_critical;
    210  int m_e2ee_enabled;
    212  #define MR_LOG_RINGBUF_SIZE 200
    213  pthread_mutex_t m_log_ringbuf_critical;
    214  char* m_log_ringbuf[MR_LOG_RINGBUF_SIZE];
    216  time_t m_log_ringbuf_times[MR_LOG_RINGBUF_SIZE];
    218  int m_log_ringbuf_pos;
    220 } mrmailbox_t;
    221 
    222 
    223 /* create/open/connect */
    224 mrmailbox_t* mrmailbox_new (mrmailboxcb_t, void* userdata, const char* os_name);
    225 void mrmailbox_unref (mrmailbox_t*);
    226 
    227 int mrmailbox_open (mrmailbox_t*, const char* dbfile, const char* blobdir);
    228 void mrmailbox_close (mrmailbox_t*);
    229 int mrmailbox_is_open (const mrmailbox_t*);
    230 
    231 int mrmailbox_set_config (mrmailbox_t*, const char* key, const char* value);
    232 char* mrmailbox_get_config (mrmailbox_t*, const char* key, const char* def);
    233 int mrmailbox_set_config_int (mrmailbox_t*, const char* key, int32_t value);
    234 int32_t mrmailbox_get_config_int (mrmailbox_t*, const char* key, int32_t def);
    235 char* mrmailbox_get_version_str (void);
    236 
    237 int mrmailbox_configure_and_connect(mrmailbox_t*);
    238 void mrmailbox_configure_cancel (mrmailbox_t*);
    239 int mrmailbox_is_configured (mrmailbox_t*);
    240 
    241 void mrmailbox_connect (mrmailbox_t*);
    242 void mrmailbox_disconnect (mrmailbox_t*);
    243 
    244 char* mrmailbox_get_info (mrmailbox_t*);
    245 
    246 
    247 /* Handle chatlists */
    248 #define MR_GCL_ARCHIVED_ONLY 0x01
    249 #define MR_GCL_NO_SPECIALS 0x02
    250 mrchatlist_t* mrmailbox_get_chatlist (mrmailbox_t*, int flags, const char* query);
    251 
    252 
    253 /* Handle chats */
    254 uint32_t mrmailbox_create_chat_by_contact_id (mrmailbox_t*, uint32_t contact_id);
    255 uint32_t mrmailbox_get_chat_id_by_contact_id (mrmailbox_t*, uint32_t contact_id);
    256 
    257 uint32_t mrmailbox_send_text_msg (mrmailbox_t*, uint32_t chat_id, const char* text_to_send);
    258 uint32_t mrmailbox_send_image_msg (mrmailbox_t*, uint32_t chat_id, const char* file, const char* filemime, int width, int height);
    259 uint32_t mrmailbox_send_video_msg (mrmailbox_t*, uint32_t chat_id, const char* file, const char* filemime, int width, int height, int duration);
    260 uint32_t mrmailbox_send_voice_msg (mrmailbox_t*, uint32_t chat_id, const char* file, const char* filemime, int duration);
    261 uint32_t mrmailbox_send_audio_msg (mrmailbox_t*, uint32_t chat_id, const char* file, const char* filemime, int duration, const char* author, const char* trackname);
    262 uint32_t mrmailbox_send_file_msg (mrmailbox_t*, uint32_t chat_id, const char* file, const char* filemime);
    263 uint32_t mrmailbox_send_vcard_msg (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    264 void mrmailbox_set_draft (mrmailbox_t*, uint32_t chat_id, const char*);
    265 
    266 #define MR_GCM_ADDDAYMARKER 0x01
    267 mrarray_t* mrmailbox_get_chat_msgs (mrmailbox_t*, uint32_t chat_id, uint32_t flags, uint32_t marker1before);
    268 int mrmailbox_get_total_msg_count (mrmailbox_t*, uint32_t chat_id);
    269 int mrmailbox_get_fresh_msg_count (mrmailbox_t*, uint32_t chat_id);
    270 mrarray_t* mrmailbox_get_fresh_msgs (mrmailbox_t*);
    271 void mrmailbox_marknoticed_chat (mrmailbox_t*, uint32_t chat_id);
    272 mrarray_t* mrmailbox_get_chat_media (mrmailbox_t*, uint32_t chat_id, int msg_type, int or_msg_type);
    273 uint32_t mrmailbox_get_next_media (mrmailbox_t*, uint32_t curr_msg_id, int dir);
    274 
    275 void mrmailbox_archive_chat (mrmailbox_t*, uint32_t chat_id, int archive);
    276 void mrmailbox_delete_chat (mrmailbox_t*, uint32_t chat_id);
    277 
    278 mrarray_t* mrmailbox_get_chat_contacts (mrmailbox_t*, uint32_t chat_id);
    279 mrarray_t* mrmailbox_search_msgs (mrmailbox_t*, uint32_t chat_id, const char* query);
    280 
    281 mrchat_t* mrmailbox_get_chat (mrmailbox_t*, uint32_t chat_id);
    282 
    283 
    284 /* Handle group chats */
    285 uint32_t mrmailbox_create_group_chat (mrmailbox_t*, const char* name);
    286 int mrmailbox_is_contact_in_chat (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    287 int mrmailbox_add_contact_to_chat (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    288 int mrmailbox_remove_contact_from_chat (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    289 int mrmailbox_set_chat_name (mrmailbox_t*, uint32_t chat_id, const char* name);
    290 int mrmailbox_set_chat_profile_image (mrmailbox_t*, uint32_t chat_id, const char* image);
    291 
    292 
    293 /* Handle messages */
    294 char* mrmailbox_get_msg_info (mrmailbox_t*, uint32_t msg_id);
    295 void mrmailbox_delete_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt);
    296 void mrmailbox_forward_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt, uint32_t chat_id);
    297 void mrmailbox_marknoticed_contact (mrmailbox_t*, uint32_t contact_id);
    298 void mrmailbox_markseen_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt);
    299 void mrmailbox_star_msgs (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt, int star);
    300 mrmsg_t* mrmailbox_get_msg (mrmailbox_t*, uint32_t msg_id);
    301 
    302 
    303 /* Handle contacts */
    304 uint32_t mrmailbox_create_contact (mrmailbox_t*, const char* name, const char* addr);
    305 int mrmailbox_add_address_book (mrmailbox_t*, const char*);
    306 mrarray_t* mrmailbox_get_known_contacts (mrmailbox_t*, const char* query);
    307 int mrmailbox_get_blocked_count (mrmailbox_t*);
    308 mrarray_t* mrmailbox_get_blocked_contacts (mrmailbox_t*);
    309 void mrmailbox_block_contact (mrmailbox_t*, uint32_t contact_id, int block);
    310 char* mrmailbox_get_contact_encrinfo (mrmailbox_t*, uint32_t contact_id);
    311 int mrmailbox_delete_contact (mrmailbox_t*, uint32_t contact_id);
    312 mrcontact_t* mrmailbox_get_contact (mrmailbox_t*, uint32_t contact_id);
    313 
    314 
    315 /* Import/export and Tools */
    316 #define MR_IMEX_CANCEL 0
    317 #define MR_IMEX_EXPORT_SELF_KEYS 1 /* param1 is a directory where the keys are written to */
    318 #define MR_IMEX_IMPORT_SELF_KEYS 2 /* param1 is a directory where the keys are searched in and read from */
    319 #define MR_IMEX_EXPORT_BACKUP 11 /* param1 is a directory where the backup is written to */
    320 #define MR_IMEX_IMPORT_BACKUP 12 /* param1 is the file with the backup to import */
    321 #define MR_IMEX_EXPORT_SETUP_MESSAGE 20 /* param1 is a directory where the setup file is written to */
    322 #define MR_BAK_PREFIX "delta-chat"
    323 #define MR_BAK_SUFFIX "bak"
    324 void mrmailbox_imex (mrmailbox_t*, int what, const char* param1, const char* setup_code);
    325 char* mrmailbox_imex_has_backup (mrmailbox_t*, const char* dir);
    326 int mrmailbox_check_password (mrmailbox_t*, const char* pw);
    327 char* mrmailbox_create_setup_code (mrmailbox_t*);
    328 void mrmailbox_heartbeat (mrmailbox_t*);
    329 
    330 
    331 /* logging */
    332 void mrmailbox_log_error (mrmailbox_t*, int code, const char* msg, ...);
    333 void mrmailbox_log_error_if (int* condition, mrmailbox_t*, int code, const char* msg, ...);
    334 void mrmailbox_log_warning (mrmailbox_t*, int code, const char* msg, ...);
    335 void mrmailbox_log_info (mrmailbox_t*, int code, const char* msg, ...);
    336 void mrmailbox_log_vprintf (mrmailbox_t*, int event, int code, const char* msg, va_list);
    337 int mrmailbox_get_thread_index (void);
    338 
    339 
    340 /* error codes */
    341 #define MR_ERR_SELF_NOT_IN_GROUP 1
    342 #define MR_ERR_NONETWORK 2
    343 
    344 
    345 /* deprecated functions */
    346 int mrchat_set_draft (mrchat_t*, const char* msg); /* deprecated - use mrmailbox_set_draft() instead */
    347 #define mrpoortext_t mrlot_t
    348 #define mrpoortext_unref mrlot_unref
    349 
    350 
    351 /* library-internal */
    352 uint32_t mrmailbox_send_msg_object (mrmailbox_t*, uint32_t chat_id, mrmsg_t*);
    353 void mrmailbox_connect_to_imap (mrmailbox_t*, mrjob_t*);
    354 void mrmailbox_wake_lock (mrmailbox_t*);
    355 void mrmailbox_wake_unlock (mrmailbox_t*);
    356 int mrmailbox_poke_eml_file (mrmailbox_t*, const char* file);
    357 int mrmailbox_is_reply_to_known_message__ (mrmailbox_t*, mrmimeparser_t*);
    358 int mrmailbox_is_reply_to_messenger_message__ (mrmailbox_t*, mrmimeparser_t*);
    359 time_t mrmailbox_correct_bad_timestamp__ (mrmailbox_t* ths, uint32_t chat_id, uint32_t from_id, time_t desired_timestamp, int is_fresh_msg);
    360 void mrmailbox_add_or_lookup_contacts_by_mailbox_list__(mrmailbox_t* ths, struct mailimf_mailbox_list* mb_list, int origin, mrarray_t* ids, int* check_self);
    361 void mrmailbox_add_or_lookup_contacts_by_address_list__(mrmailbox_t* ths, struct mailimf_address_list* adr_list, int origin, mrarray_t* ids, int* check_self);
    362 int mrmailbox_get_archived_count__ (mrmailbox_t*);
    363 int mrmailbox_reset_tables (mrmailbox_t*, int bits); /* reset tables but leaves server configuration, 1=jobs, 2=e2ee, 8=rest but server config */
    364 size_t mrmailbox_get_real_contact_cnt__ (mrmailbox_t*);
    365 uint32_t mrmailbox_add_or_lookup_contact__ (mrmailbox_t*, const char* display_name /*can be NULL*/, const char* addr_spec, int origin, int* sth_modified);
    366 int mrmailbox_get_contact_origin__ (mrmailbox_t*, uint32_t id, int* ret_blocked);
    367 int mrmailbox_is_contact_blocked__ (mrmailbox_t*, uint32_t id);
    368 int mrmailbox_real_contact_exists__ (mrmailbox_t*, uint32_t id);
    369 int mrmailbox_contact_addr_equals__ (mrmailbox_t*, uint32_t contact_id, const char* other_addr);
    370 void mrmailbox_scaleup_contact_origin__ (mrmailbox_t*, uint32_t contact_id, int origin);
    371 void mrmailbox_unarchive_chat__ (mrmailbox_t*, uint32_t chat_id);
    372 size_t mrmailbox_get_chat_cnt__ (mrmailbox_t*);
    373 uint32_t mrmailbox_create_or_lookup_nchat_by_contact_id__ (mrmailbox_t*, uint32_t contact_id);
    374 uint32_t mrmailbox_lookup_real_nchat_by_contact_id__ (mrmailbox_t*, uint32_t contact_id);
    375 int mrmailbox_get_total_msg_count__ (mrmailbox_t*, uint32_t chat_id);
    376 int mrmailbox_get_fresh_msg_count__ (mrmailbox_t*, uint32_t chat_id);
    377 uint32_t mrmailbox_get_last_deaddrop_fresh_msg__ (mrmailbox_t*);
    378 void mrmailbox_send_msg_to_smtp (mrmailbox_t*, mrjob_t*);
    379 void mrmailbox_send_msg_to_imap (mrmailbox_t*, mrjob_t*);
    380 int mrmailbox_add_contact_to_chat__ (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    381 int mrmailbox_is_contact_in_chat__ (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
    382 int mrmailbox_get_chat_contact_count__ (mrmailbox_t*, uint32_t chat_id);
    383 int mrmailbox_group_explicitly_left__ (mrmailbox_t*, const char* grpid);
    384 void mrmailbox_set_group_explicitly_left__ (mrmailbox_t*, const char* grpid);
    385 size_t mrmailbox_get_real_msg_cnt__ (mrmailbox_t*); /* the number of messages assigned to real chat (!=deaddrop, !=trash) */
    386 size_t mrmailbox_get_deaddrop_msg_cnt__ (mrmailbox_t*);
    387 int mrmailbox_rfc724_mid_cnt__ (mrmailbox_t*, const char* rfc724_mid);
    388 int mrmailbox_rfc724_mid_exists__ (mrmailbox_t*, const char* rfc724_mid, char** ret_server_folder, uint32_t* ret_server_uid);
    389 void mrmailbox_update_server_uid__ (mrmailbox_t*, const char* rfc724_mid, const char* server_folder, uint32_t server_uid);
    390 void mrmailbox_update_msg_chat_id__ (mrmailbox_t*, uint32_t msg_id, uint32_t chat_id);
    391 void mrmailbox_update_msg_state__ (mrmailbox_t*, uint32_t msg_id, int state);
    392 void mrmailbox_delete_msg_on_imap (mrmailbox_t* mailbox, mrjob_t* job);
    393 int mrmailbox_mdn_from_ext__ (mrmailbox_t*, uint32_t from_id, const char* rfc724_mid, uint32_t* ret_chat_id, uint32_t* ret_msg_id); /* returns 1 if an event should be send */
    394 void mrmailbox_send_mdn (mrmailbox_t*, mrjob_t* job);
    395 void mrmailbox_markseen_msg_on_imap (mrmailbox_t* mailbox, mrjob_t* job);
    396 void mrmailbox_markseen_mdn_on_imap (mrmailbox_t* mailbox, mrjob_t* job);
    397 
    398 
    399 /* library private: end-to-end-encryption */
    400 #define MR_E2EE_DEFAULT_ENABLED 1
    401 #define MR_MDNS_DEFAULT_ENABLED 1
    402 
    403 typedef struct mrmailbox_e2ee_helper_t {
    404  int m_encryption_successfull;
    405  void* m_cdata_to_free;
    406 } mrmailbox_e2ee_helper_t;
    407 
    408 void mrmailbox_e2ee_encrypt (mrmailbox_t*, const clist* recipients_addr, int e2ee_guaranteed, int encrypt_to_self, struct mailmime* in_out_message, mrmailbox_e2ee_helper_t*);
    409 int mrmailbox_e2ee_decrypt (mrmailbox_t*, struct mailmime* in_out_message, int* ret_validation_errors); /* returns 1 if sth. was decrypted, 0 in other cases */
    410 void mrmailbox_e2ee_thanks (mrmailbox_e2ee_helper_t*); /* frees data referenced by "mailmime" but not freed by mailmime_free(). After calling mre2ee_unhelp(), in_out_message cannot be used any longer! */
    411 int mrmailbox_ensure_secret_key_exists (mrmailbox_t*); /* makes sure, the private key exists, needed only for exporting keys and the case no message was sent before */
    412 
    413 
    414 #ifdef __cplusplus
    415 } /* /extern "C" */
    416 #endif
    417 #endif /* __MRMAILBOX_H__ */
    mrmailbox_t::mrmailbox_add_address_book
    int mrmailbox_add_address_book(mrmailbox_t *mailbox, const char *adr_book)
    Add a number of contacts.
    Definition: mrmailbox.c:4337
    mrmailbox_t::mrmailbox_create_group_chat
    uint32_t mrmailbox_create_group_chat(mrmailbox_t *mailbox, const char *chat_name)
    Create a new group chat.
    Definition: mrmailbox.c:3625
    mrmailbox_t::mrmailbox_create_contact
    uint32_t mrmailbox_create_contact(mrmailbox_t *mailbox, const char *name, const char *addr)
    Add a single contact.
    Definition: mrmailbox.c:4294
    mrmailbox_t::mrmailbox_send_text_msg
    uint32_t mrmailbox_send_text_msg(mrmailbox_t *mailbox, uint32_t chat_id, const char *text_to_send)
    Send a simple text message a given chat.
    Definition: mrmailbox.c:3247
    @@ -101,7 +101,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    mrmailbox_t::mrmailbox_remove_contact_from_chat
    int mrmailbox_remove_contact_from_chat(mrmailbox_t *mailbox, uint32_t chat_id, uint32_t contact_id)
    Remove a member from a group.
    Definition: mrmailbox.c:3980
    mrmailbox_t::mrmailbox_open
    int mrmailbox_open(mrmailbox_t *mailbox, const char *dbfile, const char *blobdir)
    Open mailbox database.
    Definition: mrmailbox.c:1016
    mrcontact_t
    An object representing a single contact in memory.
    Definition: mrcontact.h:38
    -
    mrarray_t
    An object representing a simple array.
    Definition: mrarray.h:39
    +
    mrarray_t
    An object containing a simple array.
    Definition: mrarray.h:39
    mrmailbox_t::mrmailbox_get_chat_msgs
    mrarray_t * mrmailbox_get_chat_msgs(mrmailbox_t *mailbox, uint32_t chat_id, uint32_t flags, uint32_t marker1before)
    Get all message IDs belonging to a chat.
    Definition: mrmailbox.c:2109
    mrmailbox_t::mrmailbox_send_file_msg
    uint32_t mrmailbox_send_file_msg(mrmailbox_t *mailbox, uint32_t chat_id, const char *file, const char *filemime)
    Send a document to a chat.
    Definition: mrmailbox.c:3462
    mrmailbox_t::mrmailbox_delete_contact
    int mrmailbox_delete_contact(mrmailbox_t *mailbox, uint32_t contact_id)
    Delete a contact.
    Definition: mrmailbox.c:4825
    diff --git a/docs/html/mrmsg_8h_source.html b/docs/html/mrmsg_8h_source.html index 824abb3c..1d97adc8 100644 --- a/docs/html/mrmsg_8h_source.html +++ b/docs/html/mrmsg_8h_source.html @@ -89,34 +89,34 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    mrmsg.h
    -
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 #ifndef __MRMSG_H__
    24 #define __MRMSG_H__
    25 #ifdef __cplusplus
    26 extern "C" {
    27 #endif
    28 
    29 
    30 typedef struct mrmailbox_t mrmailbox_t;
    31 typedef struct mrparam_t mrparam_t;
    32 typedef struct sqlite3_stmt sqlite3_stmt;
    33 
    34 
    40 typedef struct mrmsg_t
    41 {
    45  uint32_t m_id;
    46  #define MR_MSG_ID_MARKER1 1
    47  #define MR_MSG_ID_DAYMARKER 9
    48  #define MR_MSG_ID_LAST_SPECIAL 9
    49 
    50 
    55  uint32_t m_from_id;
    56 
    57 
    62  uint32_t m_to_id;
    63 
    64 
    69  uint32_t m_chat_id;
    70 
    71 
    72  /*
    73  * The mailbox object the chat belongs to. Never NULL.
    74  */
    75  //mrmailbox_t* m_mailbox;
    76 
    77 
    80  int m_type;
    81  #define MR_MSG_UNDEFINED 0
    82  #define MR_MSG_TEXT 10
    83  #define MR_MSG_IMAGE 20 /* m_param may contain MRP_FILE, MRP_WIDTH, MRP_HEIGHT */
    84  #define MR_MSG_GIF 21 /* - " - */
    85  #define MR_MSG_AUDIO 40 /* m_param may contain MRP_FILE, MRP_DURATION */
    86  #define MR_MSG_VOICE 41 /* - " - */
    87  #define MR_MSG_VIDEO 50 /* m_param may contain MRP_FILE, MRP_WIDTH, MRP_HEIGHT, MRP_DURATION */
    88  #define MR_MSG_FILE 60 /* m_param may contain MRP_FILE */
    89 
    90  int m_state;
    91  #define MR_STATE_UNDEFINED 0
    92  #define MR_STATE_IN_FRESH 10
    93  #define MR_STATE_IN_NOTICED 13
    94  #define MR_STATE_IN_SEEN 16
    95  #define MR_STATE_OUT_PENDING 20
    96  #define MR_STATE_OUT_ERROR 24
    97  #define MR_STATE_OUT_DELIVERED 26
    98  #define MR_STATE_OUT_MDN_RCVD 28
    99 
    100  time_t m_timestamp;
    101  char* m_text;
    103  mrmailbox_t* m_mailbox;
    104  char* m_rfc724_mid;
    105  char* m_server_folder;
    106  uint32_t m_server_uid;
    107  int m_is_msgrmsg;
    108  int m_starred;
    109  mrparam_t* m_param;
    110 } mrmsg_t;
    111 
    112 
    113 mrmsg_t* mrmsg_new ();
    114 void mrmsg_unref (mrmsg_t*);
    115 void mrmsg_empty (mrmsg_t*);
    116 
    117 int mrmsg_get_type (mrmsg_t*);
    118 int mrmsg_get_state (mrmsg_t*);
    119 time_t mrmsg_get_timestamp (mrmsg_t*);
    120 char* mrmsg_get_text (mrmsg_t*);
    121 char* mrmsg_get_file (mrmsg_t*);
    122 char* mrmsg_get_filename (mrmsg_t*);
    123 char* mrmsg_get_filemime (mrmsg_t*);
    124 uint64_t mrmsg_get_filebytes (mrmsg_t*);
    125 mrpoortext_t* mrmsg_get_mediainfo (mrmsg_t*);
    126 int mrmsg_get_width (mrmsg_t*);
    127 int mrmsg_get_height (mrmsg_t*);
    128 int mrmsg_get_duration (mrmsg_t*);
    129 int mrmsg_get_showpadlock (mrmsg_t*);
    130 mrpoortext_t* mrmsg_get_summary (mrmsg_t*, mrchat_t*);
    131 char* mrmsg_get_summarytext (mrmsg_t*, int approx_characters);
    132 int mrmsg_is_starred (mrmsg_t*);
    133 int mrmsg_is_forwarded (mrmsg_t*);
    134 int mrmsg_is_systemcmd (mrmsg_t*);
    135 int mrmsg_is_increation (mrmsg_t*);
    136 
    137 void mrmsg_latefiling_mediasize (mrmsg_t*, int width, int height, int duration);
    138 
    139 
    140 /* library-private */
    141 #define MR_MSG_FIELDS " m.id,rfc724_mid,m.server_folder,m.server_uid,m.chat_id, m.from_id,m.to_id,m.timestamp, m.type,m.state,m.msgrmsg,m.txt, m.param,m.starred "
    142 int mrmsg_set_from_stmt__ (mrmsg_t*, sqlite3_stmt* row, int row_offset); /* row order is MR_MSG_FIELDS */
    143 int mrmsg_load_from_db__ (mrmsg_t*, mrmailbox_t*, uint32_t id);
    144 int mrmsg_is_increation__ (const mrmsg_t*);
    145 char* mrmsg_get_summarytext_by_raw (int type, const char* text, mrparam_t*, int approx_bytes); /* the returned value must be free()'d */
    146 void mrmsg_save_param_to_disk__ (mrmsg_t*);
    147 void mrmsg_guess_msgtype_from_suffix (const char* pathNfilename, int* ret_msgtype, char** ret_mime);
    148 void mrmsg_get_authorNtitle_from_filename (const char* pathNfilename, char** ret_author, char** ret_title);
    149 
    150 #define MR_MSG_NEEDS_ATTACHMENT(a) ((a)==MR_MSG_IMAGE || (a)==MR_MSG_GIF || (a)==MR_MSG_AUDIO || (a)==MR_MSG_VOICE || (a)==MR_MSG_VIDEO || (a)==MR_MSG_FILE)
    151 #define MR_MSG_MAKE_FILENAME_SEARCHABLE(a) ((a)==MR_MSG_AUDIO || (a)==MR_MSG_FILE || (a)==MR_MSG_VIDEO ) /* add filename.ext (without path) to m_text? this is needed for the fulltext search. The extension is useful to get all PDF, all MP3 etc. */
    152 #define MR_MSG_MAKE_SUFFIX_SEARCHABLE(a) ((a)==MR_MSG_IMAGE || (a)==MR_MSG_GIF || (a)==MR_MSG_VOICE)
    153 
    154 #define APPROX_SUBJECT_CHARS 32 /* as we do not cut inside words, this results in about 32-42 characters.
    155  Do not use too long subjects - we add a tag after the subject which gets truncated by the clients otherwise.
    156  It should also be very clear, the subject is _not_ the whole message.
    157  The value is also used for CC:-summaries */
    158 
    159 
    160 #ifdef __cplusplus
    161 } /* /extern "C" */
    162 #endif
    163 #endif /* __MRMSG_H__ */
    mrmailbox_t
    An object representing a single mailbox.
    Definition: mrmailbox.h:184
    -
    mrmsg_t::mrmsg_is_systemcmd
    int mrmsg_is_systemcmd(mrmsg_t *msg)
    Check if the message is a system command.
    Definition: mrmsg.c:627
    +
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 #ifndef __MRMSG_H__
    24 #define __MRMSG_H__
    25 #ifdef __cplusplus
    26 extern "C" {
    27 #endif
    28 
    29 
    30 typedef struct mrmailbox_t mrmailbox_t;
    31 typedef struct mrparam_t mrparam_t;
    32 typedef struct sqlite3_stmt sqlite3_stmt;
    33 
    34 
    40 typedef struct mrmsg_t
    41 {
    45  uint32_t m_id;
    46  #define MR_MSG_ID_MARKER1 1
    47  #define MR_MSG_ID_DAYMARKER 9
    48  #define MR_MSG_ID_LAST_SPECIAL 9
    49 
    50 
    55  uint32_t m_from_id;
    56 
    57 
    62  uint32_t m_to_id;
    63 
    64 
    69  uint32_t m_chat_id;
    70 
    71 
    72  /*
    73  * The mailbox object the chat belongs to. Never NULL.
    74  */
    75  //mrmailbox_t* m_mailbox;
    76 
    77 
    80  int m_type;
    81  #define MR_MSG_UNDEFINED 0
    82  #define MR_MSG_TEXT 10
    83  #define MR_MSG_IMAGE 20 /* m_param may contain MRP_FILE, MRP_WIDTH, MRP_HEIGHT */
    84  #define MR_MSG_GIF 21 /* - " - */
    85  #define MR_MSG_AUDIO 40 /* m_param may contain MRP_FILE, MRP_DURATION */
    86  #define MR_MSG_VOICE 41 /* - " - */
    87  #define MR_MSG_VIDEO 50 /* m_param may contain MRP_FILE, MRP_WIDTH, MRP_HEIGHT, MRP_DURATION */
    88  #define MR_MSG_FILE 60 /* m_param may contain MRP_FILE */
    89 
    90  int m_state;
    91  #define MR_STATE_UNDEFINED 0
    92  #define MR_STATE_IN_FRESH 10
    93  #define MR_STATE_IN_NOTICED 13
    94  #define MR_STATE_IN_SEEN 16
    95  #define MR_STATE_OUT_PENDING 20
    96  #define MR_STATE_OUT_ERROR 24
    97  #define MR_STATE_OUT_DELIVERED 26
    98  #define MR_STATE_OUT_MDN_RCVD 28
    99 
    100  time_t m_timestamp;
    101  char* m_text;
    103  mrmailbox_t* m_mailbox;
    104  char* m_rfc724_mid;
    105  char* m_server_folder;
    106  uint32_t m_server_uid;
    107  int m_is_msgrmsg;
    108  int m_starred;
    109  mrparam_t* m_param;
    110 } mrmsg_t;
    111 
    112 
    113 mrmsg_t* mrmsg_new ();
    114 void mrmsg_unref (mrmsg_t*);
    115 void mrmsg_empty (mrmsg_t*);
    116 
    117 int mrmsg_get_type (mrmsg_t*);
    118 int mrmsg_get_state (mrmsg_t*);
    119 time_t mrmsg_get_timestamp (mrmsg_t*);
    120 char* mrmsg_get_text (mrmsg_t*);
    121 char* mrmsg_get_file (mrmsg_t*);
    122 char* mrmsg_get_filename (mrmsg_t*);
    123 char* mrmsg_get_filemime (mrmsg_t*);
    124 uint64_t mrmsg_get_filebytes (mrmsg_t*);
    125 mrlot_t* mrmsg_get_mediainfo (mrmsg_t*);
    126 int mrmsg_get_width (mrmsg_t*);
    127 int mrmsg_get_height (mrmsg_t*);
    128 int mrmsg_get_duration (mrmsg_t*);
    129 int mrmsg_get_showpadlock (mrmsg_t*);
    130 mrlot_t* mrmsg_get_summary (mrmsg_t*, mrchat_t*);
    131 char* mrmsg_get_summarytext (mrmsg_t*, int approx_characters);
    132 int mrmsg_is_starred (mrmsg_t*);
    133 int mrmsg_is_forwarded (mrmsg_t*);
    134 int mrmsg_is_systemcmd (mrmsg_t*);
    135 int mrmsg_is_increation (mrmsg_t*);
    136 
    137 void mrmsg_latefiling_mediasize (mrmsg_t*, int width, int height, int duration);
    138 
    139 
    140 /* library-private */
    141 #define MR_MSG_FIELDS " m.id,rfc724_mid,m.server_folder,m.server_uid,m.chat_id, m.from_id,m.to_id,m.timestamp, m.type,m.state,m.msgrmsg,m.txt, m.param,m.starred "
    142 int mrmsg_set_from_stmt__ (mrmsg_t*, sqlite3_stmt* row, int row_offset); /* row order is MR_MSG_FIELDS */
    143 int mrmsg_load_from_db__ (mrmsg_t*, mrmailbox_t*, uint32_t id);
    144 int mrmsg_is_increation__ (const mrmsg_t*);
    145 char* mrmsg_get_summarytext_by_raw (int type, const char* text, mrparam_t*, int approx_bytes); /* the returned value must be free()'d */
    146 void mrmsg_save_param_to_disk__ (mrmsg_t*);
    147 void mrmsg_guess_msgtype_from_suffix (const char* pathNfilename, int* ret_msgtype, char** ret_mime);
    148 void mrmsg_get_authorNtitle_from_filename (const char* pathNfilename, char** ret_author, char** ret_title);
    149 
    150 #define MR_MSG_NEEDS_ATTACHMENT(a) ((a)==MR_MSG_IMAGE || (a)==MR_MSG_GIF || (a)==MR_MSG_AUDIO || (a)==MR_MSG_VOICE || (a)==MR_MSG_VIDEO || (a)==MR_MSG_FILE)
    151 #define MR_MSG_MAKE_FILENAME_SEARCHABLE(a) ((a)==MR_MSG_AUDIO || (a)==MR_MSG_FILE || (a)==MR_MSG_VIDEO ) /* add filename.ext (without path) to m_text? this is needed for the fulltext search. The extension is useful to get all PDF, all MP3 etc. */
    152 #define MR_MSG_MAKE_SUFFIX_SEARCHABLE(a) ((a)==MR_MSG_IMAGE || (a)==MR_MSG_GIF || (a)==MR_MSG_VOICE)
    153 
    154 #define APPROX_SUBJECT_CHARS 32 /* as we do not cut inside words, this results in about 32-42 characters.
    155  Do not use too long subjects - we add a tag after the subject which gets truncated by the clients otherwise.
    156  It should also be very clear, the subject is _not_ the whole message.
    157  The value is also used for CC:-summaries */
    158 
    159 
    160 #ifdef __cplusplus
    161 } /* /extern "C" */
    162 #endif
    163 #endif /* __MRMSG_H__ */
    mrmailbox_t
    An object representing a single mailbox.
    Definition: mrmailbox.h:184
    +
    mrmsg_t::mrmsg_is_systemcmd
    int mrmsg_is_systemcmd(mrmsg_t *msg)
    Check if the message is a system command.
    Definition: mrmsg.c:647
    mrmsg_t::mrmsg_get_type
    int mrmsg_get_type(mrmsg_t *msg)
    Get the type of the message.
    Definition: mrmsg.c:124
    -
    mrmsg_t::mrmsg_get_summarytext
    char * mrmsg_get_summarytext(mrmsg_t *msg, int approx_characters)
    Get a message summary as a single line of text.
    Definition: mrmsg.c:548
    +
    mrmsg_t::mrmsg_get_summarytext
    char * mrmsg_get_summarytext(mrmsg_t *msg, int approx_characters)
    Get a message summary as a single line of text.
    Definition: mrmsg.c:568
    mrmsg_t::mrmsg_get_filebytes
    uint64_t mrmsg_get_filebytes(mrmsg_t *msg)
    Get the size of the file.
    Definition: mrmsg.c:319
    mrmsg_t::m_chat_id
    uint32_t m_chat_id
    Chat ID the message belongs to.
    Definition: mrmsg.h:69
    mrmsg_t::mrmsg_get_state
    int mrmsg_get_state(mrmsg_t *msg)
    Get the state of a message.
    Definition: mrmsg.c:160
    -
    mrpoortext_t
    An object representing text with some attributes.
    Definition: mrpoortext.h:35
    -
    mrmsg_t::mrmsg_get_summary
    mrpoortext_t * mrmsg_get_summary(mrmsg_t *msg, mrchat_t *chat)
    Get a summary for a message.
    Definition: mrmsg.c:506
    -
    mrmsg_t::mrmsg_get_mediainfo
    mrpoortext_t * mrmsg_get_mediainfo(mrmsg_t *msg)
    Get real author and title.
    Definition: mrmsg.c:352
    +
    mrmsg_t::mrmsg_get_mediainfo
    mrlot_t * mrmsg_get_mediainfo(mrmsg_t *msg)
    Get real author and title.
    Definition: mrmsg.c:357
    mrmsg_t
    An object representing a single message in memory.
    Definition: mrmsg.h:40
    -
    mrmsg_t::mrmsg_latefiling_mediasize
    void mrmsg_latefiling_mediasize(mrmsg_t *msg, int width, int height, int duration)
    Late filing information to a message.
    Definition: mrmsg.c:921
    +
    mrmsg_t::mrmsg_latefiling_mediasize
    void mrmsg_latefiling_mediasize(mrmsg_t *msg, int width, int height, int duration)
    Late filing information to a message.
    Definition: mrmsg.c:941
    +
    mrmsg_t::mrmsg_get_summary
    mrlot_t * mrmsg_get_summary(mrmsg_t *msg, mrchat_t *chat)
    Get a summary for a message.
    Definition: mrmsg.c:526
    mrmsg_t::m_to_id
    uint32_t m_to_id
    Contact ID of the recipient.
    Definition: mrmsg.h:62
    +
    mrlot_t
    An object containing a set of values.
    Definition: mrlot.h:36
    mrmsg_t::m_from_id
    uint32_t m_from_id
    Contact ID of the sender.
    Definition: mrmsg.h:55
    -
    mrmsg_t::mrmsg_get_duration
    int mrmsg_get_duration(mrmsg_t *msg)
    Get duration of audio or video.
    Definition: mrmsg.c:460
    -
    mrmsg_t::mrmsg_is_starred
    int mrmsg_is_starred(mrmsg_t *msg)
    Check if a message is starred.
    Definition: mrmsg.c:572
    +
    mrmsg_t::mrmsg_get_duration
    int mrmsg_get_duration(mrmsg_t *msg)
    Get duration of audio or video.
    Definition: mrmsg.c:465
    +
    mrmsg_t::mrmsg_is_starred
    int mrmsg_is_starred(mrmsg_t *msg)
    Check if a message is starred.
    Definition: mrmsg.c:592
    mrmsg_t::mrmsg_get_file
    char * mrmsg_get_file(mrmsg_t *msg)
    Find out full path, file name and extension of the file associated with a message.
    Definition: mrmsg.c:219
    -
    mrmsg_t::mrmsg_is_increation
    int mrmsg_is_increation(mrmsg_t *msg)
    Check if a message is still in creation.
    Definition: mrmsg.c:867
    +
    mrmsg_t::mrmsg_is_increation
    int mrmsg_is_increation(mrmsg_t *msg)
    Check if a message is still in creation.
    Definition: mrmsg.c:887
    mrmsg_t::mrmsg_unref
    void mrmsg_unref(mrmsg_t *msg)
    Free a message object.
    Definition: mrmsg.c:66
    mrmsg_t::m_id
    uint32_t m_id
    Message ID.
    Definition: mrmsg.h:45
    mrmsg_t::mrmsg_get_filemime
    char * mrmsg_get_filemime(mrmsg_t *msg)
    Get mime type of the file.
    Definition: mrmsg.c:278
    -
    mrmsg_t::mrmsg_get_width
    int mrmsg_get_width(mrmsg_t *msg)
    Get width of image or video.
    Definition: mrmsg.c:413
    +
    mrmsg_t::mrmsg_get_width
    int mrmsg_get_width(mrmsg_t *msg)
    Get width of image or video.
    Definition: mrmsg.c:418
    mrmsg_t::mrmsg_get_timestamp
    time_t mrmsg_get_timestamp(mrmsg_t *msg)
    Get message time.
    Definition: mrmsg.c:178
    -
    mrmsg_t::mrmsg_get_showpadlock
    int mrmsg_get_showpadlock(mrmsg_t *msg)
    Check if a padlock should be shown beside the message.
    Definition: mrmsg.c:478
    +
    mrmsg_t::mrmsg_get_showpadlock
    int mrmsg_get_showpadlock(mrmsg_t *msg)
    Check if a padlock should be shown beside the message.
    Definition: mrmsg.c:483
    mrmsg_t::mrmsg_get_filename
    char * mrmsg_get_filename(mrmsg_t *msg)
    Get base file name without path.
    Definition: mrmsg.c:246
    mrmsg_t::mrmsg_get_text
    char * mrmsg_get_text(mrmsg_t *msg)
    Get the text of the message.
    Definition: mrmsg.c:198
    -
    mrmsg_t::mrmsg_is_forwarded
    int mrmsg_is_forwarded(mrmsg_t *msg)
    Check if the message is a forwarded message.
    Definition: mrmsg.c:600
    -
    mrmsg_t::mrmsg_get_height
    int mrmsg_get_height(mrmsg_t *msg)
    Get height of image or video.
    Definition: mrmsg.c:438
    +
    mrmsg_t::mrmsg_is_forwarded
    int mrmsg_is_forwarded(mrmsg_t *msg)
    Check if the message is a forwarded message.
    Definition: mrmsg.c:620
    +
    mrmsg_t::mrmsg_get_height
    int mrmsg_get_height(mrmsg_t *msg)
    Get height of image or video.
    Definition: mrmsg.c:443
    mrchat_t
    An object representing a single chat in memory.
    Definition: mrchat.h:39
    diff --git a/docs/html/mrpoortext_8h_source.html b/docs/html/mrpoortext_8h_source.html index 4ec9093b..fb8e5b24 100644 --- a/docs/html/mrpoortext_8h_source.html +++ b/docs/html/mrpoortext_8h_source.html @@ -89,14 +89,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    mrpoortext.h
    -
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 #ifndef __MRPOORTEXT_H__
    24 #define __MRPOORTEXT_H__
    25 #ifdef __cplusplus
    26 extern "C" {
    27 #endif
    28 
    29 
    35 typedef struct mrpoortext_t
    36 {
    43  int m_text1_meaning;
    44 
    45  char* m_text1;
    46  char* m_text2;
    47  time_t m_timestamp;
    48  int m_state;
    49 } mrpoortext_t;
    50 
    51 
    52 #define MR_TEXT1_NORMAL 0
    53 #define MR_TEXT1_DRAFT 1
    54 #define MR_TEXT1_USERNAME 2
    55 #define MR_TEXT1_SELF 3
    56 
    57 
    58 mrpoortext_t* mrpoortext_new ();
    59 void mrpoortext_empty (mrpoortext_t*);
    60 void mrpoortext_unref (mrpoortext_t*);
    61 
    62 
    63 #define MR_SUMMARY_CHARACTERS 160
    64 void mrpoortext_fill (mrpoortext_t*, const mrmsg_t*, const mrchat_t*, const mrcontact_t*);
    65 
    66 
    67 #ifdef __cplusplus
    68 } /* /extern "C" */
    69 #endif
    70 #endif /* __MRPOORTEXT_H__ */
    mrpoortext_t::mrpoortext_unref
    void mrpoortext_unref(mrpoortext_t *poortext)
    Frees a poortext object.
    Definition: mrpoortext.c:55
    -
    mrpoortext_t::m_text2
    char * m_text2
    The meaning is defined by the creator of the object.
    Definition: mrpoortext.h:46
    -
    mrpoortext_t::m_state
    int m_state
    Typically a MR_MSG_STATE_* constant.
    Definition: mrpoortext.h:48
    -
    mrpoortext_t::m_timestamp
    time_t m_timestamp
    Typically a message timestamp.
    Definition: mrpoortext.h:47
    -
    mrpoortext_t::m_text1
    char * m_text1
    The meaning is defined by m_text1_meaning and by the creator of the object.
    Definition: mrpoortext.h:45
    -
    mrpoortext_t
    An object representing text with some attributes.
    Definition: mrpoortext.h:35
    -
    mrpoortext_t::m_text1_meaning
    int m_text1_meaning
    Defines the meaning of the m_text1 string.
    Definition: mrpoortext.h:43
    -
    +
    1 /* deprecated */
    2 
    Generated by   diff --git a/docs/html/mrtools_8h_source.html b/docs/html/mrtools_8h_source.html index 5831d41a..e9e03665 100644 --- a/docs/html/mrtools_8h_source.html +++ b/docs/html/mrtools_8h_source.html @@ -89,7 +89,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    mrtools.h
    -
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 /* Some tools and enhancements to the used libraries, there should be
    24 no references to mrmailbox_t and other "larger" classes here. */
    25 
    26 
    27 #ifndef __MRTOOLS_H__
    28 #define __MRTOOLS_H__
    29 #ifdef __cplusplus
    30 extern "C" {
    31 #endif
    32 
    33 
    34 /*** library-private **********************************************************/
    35 
    36 /* match tools */
    37 int mr_exactly_one_bit_set (int v);
    38 
    39 /* string tools */
    40 char* safe_strdup (const char*); /* safe_strdup() returns empty string if NULL is given, never returns NULL (exists on errors) */
    41 char* strdup_keep_null (const char*); /* strdup(NULL) is undefined, safe_strdup_keep_null(NULL) returns NULL in this case */
    42 int atoi_null_is_0 (const char*);
    43 void mr_ltrim (char*);
    44 void mr_rtrim (char*);
    45 void mr_trim (char*);
    46 char* mr_strlower (const char*); /* the result must be free()'d */
    47 void mr_strlower_in_place (char*);
    48 int mr_str_replace (char** haystack, const char* needle, const char* replacement); /* haystack may be realloc()'d, returns the number of replacements */
    49 char* mr_null_terminate (const char*, int bytes); /* the result must be free()'d */
    50 char* mr_mprintf (const char* format, ...); /* The result must be free()'d. */
    51 void mr_remove_cr_chars (char*); /* remove all \r characters from string */
    52 void mr_replace_bad_utf8_chars (char*); /* replace bad UTF-8 characters by sequences of `_` (to avoid problems in filenames, we do not use eg. `?`) the function is useful if strings are unexpectingly encoded eg. as ISO-8859-1 */
    53 void mr_truncate_n_unwrap_str (char*, int approx_characters, int do_unwrap);
    54 carray* mr_split_into_lines (const char* buf_terminated); /* split string into lines*/
    55 void mr_free_splitted_lines (carray* lines);
    56 char* mr_insert_breaks (const char*, int break_every, const char* break_chars); /* insert a break every n characters, the return must be free()'d */
    57 char* mr_arr_to_string (const uint32_t*, int cnt);
    58 char* mr_decode_header_string (const char*); /* the result must be free()'d */
    59 char* mr_encode_header_string (const char*); /* the result must be free()'d */
    60 char* imap_modified_utf7_to_utf8 (const char *mbox, int change_spaces);
    61 char* imap_utf8_to_modified_utf7 (const char *src, int change_spaces);
    62 char* mr_url_encode (const char*); /* the result must be free()'d */
    63 char* encode_base64 (const char * in, int len); /* prototype, from libetpan/src/data-types/base64.h which cannot be included without adding libetpan/src/... to the include-search-paths, which would result in double-file-name-errors */
    64 
    65 /* string builder */
    66 typedef struct mrstrbuilder_t
    67 {
    68  char* m_buf;
    69  int m_allocated;
    70  int m_free;
    71  char* m_eos;
    72 } mrstrbuilder_t;
    73 void mrstrbuilder_init (mrstrbuilder_t* ths);
    74 char* mrstrbuilder_cat (mrstrbuilder_t* ths, const char* text);
    75 void mrstrbuilder_empty(mrstrbuilder_t* ths); /* set the string to a lenght of 0, does not free the buffer */
    76 
    77 
    78 /* clist tools */
    79 void clist_free_content (const clist*); /* calls free() for each item content */
    80 int clist_search_string_nocase (const clist*, const char* str);
    81 
    82 /* date/time tools */
    83 #define MR_INVALID_TIMESTAMP (-1)
    84 time_t mr_timestamp_from_date (struct mailimf_date_time * date_time); /* the result is UTC or MR_INVALID_TIMESTAMP */
    85 char* mr_timestamp_to_str (time_t); /* the return value must be free()'d */
    86 struct mailimap_date_time* mr_timestamp_to_mailimap_date_time (time_t);
    87 long mr_gm2local_offset (void);
    88 
    89 /* timesmearing */
    90 time_t mr_smeared_time__ (void);
    91 time_t mr_create_smeared_timestamp__ (void);
    92 time_t mr_create_smeared_timestamps__(int count);
    93 
    94 /* Message-ID tools */
    95 #define MR_VALID_ID_LEN 11
    96 char* mr_create_id (void);
    97 char* mr_create_dummy_references_mid (void);
    98 char* mr_create_incoming_rfc724_mid (time_t message_timestamp, uint32_t contact_id_from, mrarray_t* contact_ids_to);
    99 char* mr_create_outgoing_rfc724_mid (const char* grpid, const char* addr);
    100 char* mr_extract_grpid_from_rfc724_mid (const char* rfc724_mid);
    101 char* mr_extract_grpid_from_rfc724_mid_list(const clist* rfc724_mid_list);
    102 
    103 
    104 /* file tools */
    105 int mr_file_exist (const char* pathNfilename);
    106 uint64_t mr_get_filebytes (const char* pathNfilename);
    107 char* mr_get_filename (const char* pathNfilename); /* the return value must be free()'d */
    108 int mr_delete_file (const char* pathNFilename, mrmailbox_t* log);
    109 int mr_copy_file (const char* src_pathNFilename, const char* dest_pathNFilename, mrmailbox_t* log);
    110 int mr_create_folder (const char* pathNfilename, mrmailbox_t* log);
    111 int mr_write_file (const char* pathNfilename, const void* buf, size_t buf_bytes, mrmailbox_t* log);
    112 int mr_read_file (const char* pathNfilename, void** buf, size_t* buf_bytes, mrmailbox_t* log);
    113 char* mr_get_filesuffix_lc (const char* pathNfilename); /* the returned suffix is lower-case */
    114 void mr_split_filename (const char* pathNfilename, char** ret_basename, char** ret_all_suffixes_incl_dot); /* the case of the suffix is preserved! */
    115 int mr_get_filemeta (const void* buf, size_t buf_bytes, uint32_t* ret_width, uint32_t *ret_height);
    116 char* mr_get_fine_pathNfilename (const char* folder, const char* desired_name);
    117 
    118 /* macros */
    119 #define MR_QUOTEHELPER(name) #name
    120 #define MR_STRINGIFY(macro) MR_QUOTEHELPER(macro)
    121 #define MR_MIN(X, Y) (((X) < (Y))? (X) : (Y))
    122 #define MR_MAX(X, Y) (((X) > (Y))? (X) : (Y))
    123 
    124 
    125 #ifdef __cplusplus
    126 } /* /extern "C" */
    127 #endif
    128 #endif /* __MRTOOLS_H__ */
    mrarray_t
    An object representing a simple array.
    Definition: mrarray.h:39
    +
    1 /*******************************************************************************
    2  *
    3  * Delta Chat Core
    4  * Copyright (C) 2017 Björn Petersen
    5  * Contact: r10s@b44t.com, http://b44t.com
    6  *
    7  * This program is free software: you can redistribute it and/or modify it under
    8  * the terms of the GNU General Public License as published by the Free Software
    9  * Foundation, either version 3 of the License, or (at your option) any later
    10  * version.
    11  *
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program. If not, see http://www.gnu.org/licenses/ .
    19  *
    20  ******************************************************************************/
    21 
    22 
    23 /* Some tools and enhancements to the used libraries, there should be
    24 no references to mrmailbox_t and other "larger" classes here. */
    25 
    26 
    27 #ifndef __MRTOOLS_H__
    28 #define __MRTOOLS_H__
    29 #ifdef __cplusplus
    30 extern "C" {
    31 #endif
    32 
    33 
    34 /*** library-private **********************************************************/
    35 
    36 /* match tools */
    37 int mr_exactly_one_bit_set (int v);
    38 
    39 /* string tools */
    40 char* safe_strdup (const char*); /* safe_strdup() returns empty string if NULL is given, never returns NULL (exists on errors) */
    41 char* strdup_keep_null (const char*); /* strdup(NULL) is undefined, safe_strdup_keep_null(NULL) returns NULL in this case */
    42 int atoi_null_is_0 (const char*);
    43 void mr_ltrim (char*);
    44 void mr_rtrim (char*);
    45 void mr_trim (char*);
    46 char* mr_strlower (const char*); /* the result must be free()'d */
    47 void mr_strlower_in_place (char*);
    48 int mr_str_replace (char** haystack, const char* needle, const char* replacement); /* haystack may be realloc()'d, returns the number of replacements */
    49 char* mr_null_terminate (const char*, int bytes); /* the result must be free()'d */
    50 char* mr_mprintf (const char* format, ...); /* The result must be free()'d. */
    51 void mr_remove_cr_chars (char*); /* remove all \r characters from string */
    52 void mr_replace_bad_utf8_chars (char*); /* replace bad UTF-8 characters by sequences of `_` (to avoid problems in filenames, we do not use eg. `?`) the function is useful if strings are unexpectingly encoded eg. as ISO-8859-1 */
    53 void mr_truncate_n_unwrap_str (char*, int approx_characters, int do_unwrap);
    54 carray* mr_split_into_lines (const char* buf_terminated); /* split string into lines*/
    55 void mr_free_splitted_lines (carray* lines);
    56 char* mr_insert_breaks (const char*, int break_every, const char* break_chars); /* insert a break every n characters, the return must be free()'d */
    57 char* mr_arr_to_string (const uint32_t*, int cnt);
    58 char* mr_decode_header_string (const char*); /* the result must be free()'d */
    59 char* mr_encode_header_string (const char*); /* the result must be free()'d */
    60 char* imap_modified_utf7_to_utf8 (const char *mbox, int change_spaces);
    61 char* imap_utf8_to_modified_utf7 (const char *src, int change_spaces);
    62 char* mr_url_encode (const char*); /* the result must be free()'d */
    63 char* encode_base64 (const char * in, int len); /* prototype, from libetpan/src/data-types/base64.h which cannot be included without adding libetpan/src/... to the include-search-paths, which would result in double-file-name-errors */
    64 
    65 /* string builder */
    66 typedef struct mrstrbuilder_t
    67 {
    68  char* m_buf;
    69  int m_allocated;
    70  int m_free;
    71  char* m_eos;
    72 } mrstrbuilder_t;
    73 void mrstrbuilder_init (mrstrbuilder_t* ths);
    74 char* mrstrbuilder_cat (mrstrbuilder_t* ths, const char* text);
    75 void mrstrbuilder_empty(mrstrbuilder_t* ths); /* set the string to a lenght of 0, does not free the buffer */
    76 
    77 
    78 /* clist tools */
    79 void clist_free_content (const clist*); /* calls free() for each item content */
    80 int clist_search_string_nocase (const clist*, const char* str);
    81 
    82 /* date/time tools */
    83 #define MR_INVALID_TIMESTAMP (-1)
    84 time_t mr_timestamp_from_date (struct mailimf_date_time * date_time); /* the result is UTC or MR_INVALID_TIMESTAMP */
    85 char* mr_timestamp_to_str (time_t); /* the return value must be free()'d */
    86 struct mailimap_date_time* mr_timestamp_to_mailimap_date_time (time_t);
    87 long mr_gm2local_offset (void);
    88 
    89 /* timesmearing */
    90 time_t mr_smeared_time__ (void);
    91 time_t mr_create_smeared_timestamp__ (void);
    92 time_t mr_create_smeared_timestamps__(int count);
    93 
    94 /* Message-ID tools */
    95 #define MR_VALID_ID_LEN 11
    96 char* mr_create_id (void);
    97 char* mr_create_dummy_references_mid (void);
    98 char* mr_create_incoming_rfc724_mid (time_t message_timestamp, uint32_t contact_id_from, mrarray_t* contact_ids_to);
    99 char* mr_create_outgoing_rfc724_mid (const char* grpid, const char* addr);
    100 char* mr_extract_grpid_from_rfc724_mid (const char* rfc724_mid);
    101 char* mr_extract_grpid_from_rfc724_mid_list(const clist* rfc724_mid_list);
    102 
    103 
    104 /* file tools */
    105 int mr_file_exist (const char* pathNfilename);
    106 uint64_t mr_get_filebytes (const char* pathNfilename);
    107 char* mr_get_filename (const char* pathNfilename); /* the return value must be free()'d */
    108 int mr_delete_file (const char* pathNFilename, mrmailbox_t* log);
    109 int mr_copy_file (const char* src_pathNFilename, const char* dest_pathNFilename, mrmailbox_t* log);
    110 int mr_create_folder (const char* pathNfilename, mrmailbox_t* log);
    111 int mr_write_file (const char* pathNfilename, const void* buf, size_t buf_bytes, mrmailbox_t* log);
    112 int mr_read_file (const char* pathNfilename, void** buf, size_t* buf_bytes, mrmailbox_t* log);
    113 char* mr_get_filesuffix_lc (const char* pathNfilename); /* the returned suffix is lower-case */
    114 void mr_split_filename (const char* pathNfilename, char** ret_basename, char** ret_all_suffixes_incl_dot); /* the case of the suffix is preserved! */
    115 int mr_get_filemeta (const void* buf, size_t buf_bytes, uint32_t* ret_width, uint32_t *ret_height);
    116 char* mr_get_fine_pathNfilename (const char* folder, const char* desired_name);
    117 
    118 /* macros */
    119 #define MR_QUOTEHELPER(name) #name
    120 #define MR_STRINGIFY(macro) MR_QUOTEHELPER(macro)
    121 #define MR_MIN(X, Y) (((X) < (Y))? (X) : (Y))
    122 #define MR_MAX(X, Y) (((X) > (Y))? (X) : (Y))
    123 
    124 
    125 #ifdef __cplusplus
    126 } /* /extern "C" */
    127 #endif
    128 #endif /* __MRTOOLS_H__ */
    mrarray_t
    An object containing a simple array.
    Definition: mrarray.h:39
    mrmailbox_t
    An object representing a single mailbox.
    Definition: mrmailbox.h:184
    diff --git a/docs/html/search/all_1.js b/docs/html/search/all_1.js index 28eb10fa..21531cd1 100644 --- a/docs/html/search/all_1.js +++ b/docs/html/search/all_1.js @@ -13,11 +13,11 @@ var searchData= ['m_5fid',['m_id',['../structmrchat__t.html#a1591431716413350eaffce0b588e4911',1,'mrchat_t::m_id()'],['../structmrcontact__t.html#ab2ee31297c327e04ed14673adbd49716',1,'mrcontact_t::m_id()'],['../structmrmsg__t.html#a793898c8da24c717dc2bb1d91faac801',1,'mrmsg_t::m_id()']]], ['m_5fmailbox',['m_mailbox',['../structmrarray__t.html#abd4dde487b63dc1bd2ff00c76854af4f',1,'mrarray_t::m_mailbox()'],['../structmrchat__t.html#abf3e1a34f567e168bc0597f9a544a50d',1,'mrchat_t::m_mailbox()'],['../structmrchatlist__t.html#a025d213cde2fa547b2f3cae4e1facbf7',1,'mrchatlist_t::m_mailbox()']]], ['m_5fname',['m_name',['../structmrchat__t.html#abbd344d8d361a1a4d14bfc9b5dc57140',1,'mrchat_t::m_name()'],['../structmrcontact__t.html#a48fba862b41f7da3b8c6193c0554654b',1,'mrcontact_t::m_name()']]], - ['m_5fstate',['m_state',['../structmrpoortext__t.html#afbf2ae7473784db66127e63657e04f60',1,'mrpoortext_t']]], - ['m_5ftext1',['m_text1',['../structmrpoortext__t.html#af3b56661ccf1c783f397c15c310cf36f',1,'mrpoortext_t']]], - ['m_5ftext1_5fmeaning',['m_text1_meaning',['../structmrpoortext__t.html#a39469bd76b12fc8da2c3341433cab893',1,'mrpoortext_t']]], - ['m_5ftext2',['m_text2',['../structmrpoortext__t.html#a54e10365f38dddd070a2ab68f4177331',1,'mrpoortext_t']]], - ['m_5ftimestamp',['m_timestamp',['../structmrpoortext__t.html#a372913d9a39616e48722ea04c759f887',1,'mrpoortext_t']]], + ['m_5fstate',['m_state',['../structmrlot__t.html#acc3e27731b8dbe46733cab6001032f9a',1,'mrlot_t']]], + ['m_5ftext1',['m_text1',['../structmrlot__t.html#afa71b7a11147bc6e73313986a08fdcd7',1,'mrlot_t']]], + ['m_5ftext1_5fmeaning',['m_text1_meaning',['../structmrlot__t.html#a38067382d835f912ad1d4f7350306dc0',1,'mrlot_t']]], + ['m_5ftext2',['m_text2',['../structmrlot__t.html#ad894f96fe9a1672808944fdb0ba04628',1,'mrlot_t']]], + ['m_5ftimestamp',['m_timestamp',['../structmrlot__t.html#af71c6758491ef50b7c25a11c0d9fee17',1,'mrlot_t']]], ['m_5fto_5fid',['m_to_id',['../structmrmsg__t.html#ad549fc02587ba284fda2bbecd162b16a',1,'mrmsg_t']]], ['m_5ftype',['m_type',['../structmrchat__t.html#a568c4e6fb9633ffe9a76428db16e0201',1,'mrchat_t']]], ['m_5fuserdata',['m_userdata',['../structmrmailbox__t.html#a6c557153209e128b69301246dbf9e230',1,'mrmailbox_t']]], @@ -51,7 +51,7 @@ var searchData= ['mrchatlist_5fget_5fchat_5fid',['mrchatlist_get_chat_id',['../structmrchatlist__t.html#a8c8360c76b31057322199e8c51cadfa5',1,'mrchatlist_t']]], ['mrchatlist_5fget_5fcnt',['mrchatlist_get_cnt',['../structmrchatlist__t.html#aa132119f18e40e3151ac5fe0299daab7',1,'mrchatlist_t']]], ['mrchatlist_5fget_5fmsg_5fid',['mrchatlist_get_msg_id',['../structmrchatlist__t.html#a69b67135eeadbdbe9b4a60e645ef22b0',1,'mrchatlist_t']]], - ['mrchatlist_5fget_5fsummary',['mrchatlist_get_summary',['../structmrchatlist__t.html#ae7670d62ab7fc83aff18f299f26853d8',1,'mrchatlist_t']]], + ['mrchatlist_5fget_5fsummary',['mrchatlist_get_summary',['../structmrchatlist__t.html#a7bb0e80673ca253c7cb71ae6b9d4fa97',1,'mrchatlist_t']]], ['mrchatlist_5ft',['mrchatlist_t',['../structmrchatlist__t.html',1,'']]], ['mrchatlist_5funref',['mrchatlist_unref',['../structmrchatlist__t.html#ab036d6e066b5ff78779f36711c9ab2f9',1,'mrchatlist_t']]], ['mrcontact_5fget_5faddr',['mrcontact_get_addr',['../structmrcontact__t.html#abfe19c7f41061c1946d00556f3e4a971',1,'mrcontact_t']]], @@ -63,6 +63,8 @@ var searchData= ['mrcontact_5ft',['mrcontact_t',['../structmrcontact__t.html',1,'']]], ['mrcontact_5funref',['mrcontact_unref',['../structmrcontact__t.html#a38e17e55cd66f5e86a1dcb8d1f67797a',1,'mrcontact_t']]], ['mrevent_2eh',['mrevent.h',['../mrevent_8h.html',1,'']]], + ['mrlot_5ft',['mrlot_t',['../structmrlot__t.html',1,'']]], + ['mrlot_5funref',['mrlot_unref',['../structmrlot__t.html#a813e4d0c2f135e962cc4d5ac0753c592',1,'mrlot_t']]], ['mrmailbox_5fadd_5faddress_5fbook',['mrmailbox_add_address_book',['../structmrmailbox__t.html#a25720ea41355cc32cc93aa45709937d6',1,'mrmailbox_t']]], ['mrmailbox_5fadd_5fcontact_5fto_5fchat',['mrmailbox_add_contact_to_chat',['../structmrmailbox__t.html#a96368620971935c7ac4a0bb324ece2c9',1,'mrmailbox_t']]], ['mrmailbox_5farchive_5fchat',['mrmailbox_archive_chat',['../structmrmailbox__t.html#a8e04e43dacbe3128afd71e1d6c1b0911',1,'mrmailbox_t']]], @@ -137,10 +139,10 @@ var searchData= ['mrmsg_5fget_5ffilemime',['mrmsg_get_filemime',['../structmrmsg__t.html#a4afcbb38dd1f37fb5f7b2c6d1f4e9042',1,'mrmsg_t']]], ['mrmsg_5fget_5ffilename',['mrmsg_get_filename',['../structmrmsg__t.html#ad0dcfc0a1e33d9a88b7381e368d7895a',1,'mrmsg_t']]], ['mrmsg_5fget_5fheight',['mrmsg_get_height',['../structmrmsg__t.html#a8600ed157b44b1089783e66ce7b33353',1,'mrmsg_t']]], - ['mrmsg_5fget_5fmediainfo',['mrmsg_get_mediainfo',['../structmrmsg__t.html#ad87b7df007489b3a47c3fde79978a58a',1,'mrmsg_t']]], + ['mrmsg_5fget_5fmediainfo',['mrmsg_get_mediainfo',['../structmrmsg__t.html#a1c6dfee4004fe0e9b9f90720bad73ecb',1,'mrmsg_t']]], ['mrmsg_5fget_5fshowpadlock',['mrmsg_get_showpadlock',['../structmrmsg__t.html#a7f1bd3d845bbc5face7636aed8f8afd4',1,'mrmsg_t']]], ['mrmsg_5fget_5fstate',['mrmsg_get_state',['../structmrmsg__t.html#a1f411e4be17fb5fe408a1aa74cba90a5',1,'mrmsg_t']]], - ['mrmsg_5fget_5fsummary',['mrmsg_get_summary',['../structmrmsg__t.html#afc3d94448ada0ad7142cf168cab1462e',1,'mrmsg_t']]], + ['mrmsg_5fget_5fsummary',['mrmsg_get_summary',['../structmrmsg__t.html#a3c14a8dbd6cc7f90c642223a873312e3',1,'mrmsg_t']]], ['mrmsg_5fget_5fsummarytext',['mrmsg_get_summarytext',['../structmrmsg__t.html#a8c8c1f342f01439ae40c5cf37532387e',1,'mrmsg_t']]], ['mrmsg_5fget_5ftext',['mrmsg_get_text',['../structmrmsg__t.html#ae549e58d9ae2f73ad76bd27636b43982',1,'mrmsg_t']]], ['mrmsg_5fget_5ftimestamp',['mrmsg_get_timestamp',['../structmrmsg__t.html#af5bf52ee1adbc55c9c9d4699afee87fb',1,'mrmsg_t']]], @@ -152,7 +154,5 @@ var searchData= ['mrmsg_5fis_5fsystemcmd',['mrmsg_is_systemcmd',['../structmrmsg__t.html#a752209192e3a022d087fe6c647fb3ad9',1,'mrmsg_t']]], ['mrmsg_5flatefiling_5fmediasize',['mrmsg_latefiling_mediasize',['../structmrmsg__t.html#a9e5dc81d4e814284b465ad23abbfb6cb',1,'mrmsg_t']]], ['mrmsg_5ft',['mrmsg_t',['../structmrmsg__t.html',1,'']]], - ['mrmsg_5funref',['mrmsg_unref',['../structmrmsg__t.html#aa33212e41efff643aa7290753f3d9b02',1,'mrmsg_t']]], - ['mrpoortext_5ft',['mrpoortext_t',['../structmrpoortext__t.html',1,'']]], - ['mrpoortext_5funref',['mrpoortext_unref',['../structmrpoortext__t.html#a89c28735bfd718051ffc6b742f9c10ed',1,'mrpoortext_t']]] + ['mrmsg_5funref',['mrmsg_unref',['../structmrmsg__t.html#aa33212e41efff643aa7290753f3d9b02',1,'mrmsg_t']]] ]; diff --git a/docs/html/search/classes_0.js b/docs/html/search/classes_0.js index ccce88f3..bea7079e 100644 --- a/docs/html/search/classes_0.js +++ b/docs/html/search/classes_0.js @@ -4,7 +4,7 @@ var searchData= ['mrchat_5ft',['mrchat_t',['../structmrchat__t.html',1,'']]], ['mrchatlist_5ft',['mrchatlist_t',['../structmrchatlist__t.html',1,'']]], ['mrcontact_5ft',['mrcontact_t',['../structmrcontact__t.html',1,'']]], + ['mrlot_5ft',['mrlot_t',['../structmrlot__t.html',1,'']]], ['mrmailbox_5ft',['mrmailbox_t',['../structmrmailbox__t.html',1,'']]], - ['mrmsg_5ft',['mrmsg_t',['../structmrmsg__t.html',1,'']]], - ['mrpoortext_5ft',['mrpoortext_t',['../structmrpoortext__t.html',1,'']]] + ['mrmsg_5ft',['mrmsg_t',['../structmrmsg__t.html',1,'']]] ]; diff --git a/docs/html/search/functions_0.js b/docs/html/search/functions_0.js index b6c5c3e6..e3f43b48 100644 --- a/docs/html/search/functions_0.js +++ b/docs/html/search/functions_0.js @@ -10,7 +10,7 @@ var searchData= ['mrchatlist_5fget_5fchat_5fid',['mrchatlist_get_chat_id',['../structmrchatlist__t.html#a8c8360c76b31057322199e8c51cadfa5',1,'mrchatlist_t']]], ['mrchatlist_5fget_5fcnt',['mrchatlist_get_cnt',['../structmrchatlist__t.html#aa132119f18e40e3151ac5fe0299daab7',1,'mrchatlist_t']]], ['mrchatlist_5fget_5fmsg_5fid',['mrchatlist_get_msg_id',['../structmrchatlist__t.html#a69b67135eeadbdbe9b4a60e645ef22b0',1,'mrchatlist_t']]], - ['mrchatlist_5fget_5fsummary',['mrchatlist_get_summary',['../structmrchatlist__t.html#ae7670d62ab7fc83aff18f299f26853d8',1,'mrchatlist_t']]], + ['mrchatlist_5fget_5fsummary',['mrchatlist_get_summary',['../structmrchatlist__t.html#a7bb0e80673ca253c7cb71ae6b9d4fa97',1,'mrchatlist_t']]], ['mrchatlist_5funref',['mrchatlist_unref',['../structmrchatlist__t.html#ab036d6e066b5ff78779f36711c9ab2f9',1,'mrchatlist_t']]], ['mrcontact_5fget_5faddr',['mrcontact_get_addr',['../structmrcontact__t.html#abfe19c7f41061c1946d00556f3e4a971',1,'mrcontact_t']]], ['mrcontact_5fget_5fdisplay_5fname',['mrcontact_get_display_name',['../structmrcontact__t.html#a29a93300d97183f795fc711c93fac689',1,'mrcontact_t']]], @@ -19,6 +19,7 @@ var searchData= ['mrcontact_5fget_5fname_5fn_5faddr',['mrcontact_get_name_n_addr',['../structmrcontact__t.html#a2658329d9e3c74f93943dfd8c25554b2',1,'mrcontact_t']]], ['mrcontact_5fnormalize_5fname',['mrcontact_normalize_name',['../structmrcontact__t.html#ad906207191f0cfd62e408dbc82a156cf',1,'mrcontact_t']]], ['mrcontact_5funref',['mrcontact_unref',['../structmrcontact__t.html#a38e17e55cd66f5e86a1dcb8d1f67797a',1,'mrcontact_t']]], + ['mrlot_5funref',['mrlot_unref',['../structmrlot__t.html#a813e4d0c2f135e962cc4d5ac0753c592',1,'mrlot_t']]], ['mrmailbox_5fadd_5faddress_5fbook',['mrmailbox_add_address_book',['../structmrmailbox__t.html#a25720ea41355cc32cc93aa45709937d6',1,'mrmailbox_t']]], ['mrmailbox_5fadd_5fcontact_5fto_5fchat',['mrmailbox_add_contact_to_chat',['../structmrmailbox__t.html#a96368620971935c7ac4a0bb324ece2c9',1,'mrmailbox_t']]], ['mrmailbox_5farchive_5fchat',['mrmailbox_archive_chat',['../structmrmailbox__t.html#a8e04e43dacbe3128afd71e1d6c1b0911',1,'mrmailbox_t']]], @@ -91,10 +92,10 @@ var searchData= ['mrmsg_5fget_5ffilemime',['mrmsg_get_filemime',['../structmrmsg__t.html#a4afcbb38dd1f37fb5f7b2c6d1f4e9042',1,'mrmsg_t']]], ['mrmsg_5fget_5ffilename',['mrmsg_get_filename',['../structmrmsg__t.html#ad0dcfc0a1e33d9a88b7381e368d7895a',1,'mrmsg_t']]], ['mrmsg_5fget_5fheight',['mrmsg_get_height',['../structmrmsg__t.html#a8600ed157b44b1089783e66ce7b33353',1,'mrmsg_t']]], - ['mrmsg_5fget_5fmediainfo',['mrmsg_get_mediainfo',['../structmrmsg__t.html#ad87b7df007489b3a47c3fde79978a58a',1,'mrmsg_t']]], + ['mrmsg_5fget_5fmediainfo',['mrmsg_get_mediainfo',['../structmrmsg__t.html#a1c6dfee4004fe0e9b9f90720bad73ecb',1,'mrmsg_t']]], ['mrmsg_5fget_5fshowpadlock',['mrmsg_get_showpadlock',['../structmrmsg__t.html#a7f1bd3d845bbc5face7636aed8f8afd4',1,'mrmsg_t']]], ['mrmsg_5fget_5fstate',['mrmsg_get_state',['../structmrmsg__t.html#a1f411e4be17fb5fe408a1aa74cba90a5',1,'mrmsg_t']]], - ['mrmsg_5fget_5fsummary',['mrmsg_get_summary',['../structmrmsg__t.html#afc3d94448ada0ad7142cf168cab1462e',1,'mrmsg_t']]], + ['mrmsg_5fget_5fsummary',['mrmsg_get_summary',['../structmrmsg__t.html#a3c14a8dbd6cc7f90c642223a873312e3',1,'mrmsg_t']]], ['mrmsg_5fget_5fsummarytext',['mrmsg_get_summarytext',['../structmrmsg__t.html#a8c8c1f342f01439ae40c5cf37532387e',1,'mrmsg_t']]], ['mrmsg_5fget_5ftext',['mrmsg_get_text',['../structmrmsg__t.html#ae549e58d9ae2f73ad76bd27636b43982',1,'mrmsg_t']]], ['mrmsg_5fget_5ftimestamp',['mrmsg_get_timestamp',['../structmrmsg__t.html#af5bf52ee1adbc55c9c9d4699afee87fb',1,'mrmsg_t']]], @@ -105,6 +106,5 @@ var searchData= ['mrmsg_5fis_5fstarred',['mrmsg_is_starred',['../structmrmsg__t.html#af202a7e7527df4681cd3ea24f779848f',1,'mrmsg_t']]], ['mrmsg_5fis_5fsystemcmd',['mrmsg_is_systemcmd',['../structmrmsg__t.html#a752209192e3a022d087fe6c647fb3ad9',1,'mrmsg_t']]], ['mrmsg_5flatefiling_5fmediasize',['mrmsg_latefiling_mediasize',['../structmrmsg__t.html#a9e5dc81d4e814284b465ad23abbfb6cb',1,'mrmsg_t']]], - ['mrmsg_5funref',['mrmsg_unref',['../structmrmsg__t.html#aa33212e41efff643aa7290753f3d9b02',1,'mrmsg_t']]], - ['mrpoortext_5funref',['mrpoortext_unref',['../structmrpoortext__t.html#a89c28735bfd718051ffc6b742f9c10ed',1,'mrpoortext_t']]] + ['mrmsg_5funref',['mrmsg_unref',['../structmrmsg__t.html#aa33212e41efff643aa7290753f3d9b02',1,'mrmsg_t']]] ]; diff --git a/docs/html/search/variables_0.js b/docs/html/search/variables_0.js index fb7ffbe0..a709566a 100644 --- a/docs/html/search/variables_0.js +++ b/docs/html/search/variables_0.js @@ -13,11 +13,11 @@ var searchData= ['m_5fid',['m_id',['../structmrchat__t.html#a1591431716413350eaffce0b588e4911',1,'mrchat_t::m_id()'],['../structmrcontact__t.html#ab2ee31297c327e04ed14673adbd49716',1,'mrcontact_t::m_id()'],['../structmrmsg__t.html#a793898c8da24c717dc2bb1d91faac801',1,'mrmsg_t::m_id()']]], ['m_5fmailbox',['m_mailbox',['../structmrarray__t.html#abd4dde487b63dc1bd2ff00c76854af4f',1,'mrarray_t::m_mailbox()'],['../structmrchat__t.html#abf3e1a34f567e168bc0597f9a544a50d',1,'mrchat_t::m_mailbox()'],['../structmrchatlist__t.html#a025d213cde2fa547b2f3cae4e1facbf7',1,'mrchatlist_t::m_mailbox()']]], ['m_5fname',['m_name',['../structmrchat__t.html#abbd344d8d361a1a4d14bfc9b5dc57140',1,'mrchat_t::m_name()'],['../structmrcontact__t.html#a48fba862b41f7da3b8c6193c0554654b',1,'mrcontact_t::m_name()']]], - ['m_5fstate',['m_state',['../structmrpoortext__t.html#afbf2ae7473784db66127e63657e04f60',1,'mrpoortext_t']]], - ['m_5ftext1',['m_text1',['../structmrpoortext__t.html#af3b56661ccf1c783f397c15c310cf36f',1,'mrpoortext_t']]], - ['m_5ftext1_5fmeaning',['m_text1_meaning',['../structmrpoortext__t.html#a39469bd76b12fc8da2c3341433cab893',1,'mrpoortext_t']]], - ['m_5ftext2',['m_text2',['../structmrpoortext__t.html#a54e10365f38dddd070a2ab68f4177331',1,'mrpoortext_t']]], - ['m_5ftimestamp',['m_timestamp',['../structmrpoortext__t.html#a372913d9a39616e48722ea04c759f887',1,'mrpoortext_t']]], + ['m_5fstate',['m_state',['../structmrlot__t.html#acc3e27731b8dbe46733cab6001032f9a',1,'mrlot_t']]], + ['m_5ftext1',['m_text1',['../structmrlot__t.html#afa71b7a11147bc6e73313986a08fdcd7',1,'mrlot_t']]], + ['m_5ftext1_5fmeaning',['m_text1_meaning',['../structmrlot__t.html#a38067382d835f912ad1d4f7350306dc0',1,'mrlot_t']]], + ['m_5ftext2',['m_text2',['../structmrlot__t.html#ad894f96fe9a1672808944fdb0ba04628',1,'mrlot_t']]], + ['m_5ftimestamp',['m_timestamp',['../structmrlot__t.html#af71c6758491ef50b7c25a11c0d9fee17',1,'mrlot_t']]], ['m_5fto_5fid',['m_to_id',['../structmrmsg__t.html#ad549fc02587ba284fda2bbecd162b16a',1,'mrmsg_t']]], ['m_5ftype',['m_type',['../structmrchat__t.html#a568c4e6fb9633ffe9a76428db16e0201',1,'mrchat_t']]], ['m_5fuserdata',['m_userdata',['../structmrmailbox__t.html#a6c557153209e128b69301246dbf9e230',1,'mrmailbox_t']]] diff --git a/docs/html/structmrarray__t.html b/docs/html/structmrarray__t.html index 74a4f572..8f03d238 100644 --- a/docs/html/structmrarray__t.html +++ b/docs/html/structmrarray__t.html @@ -90,7 +90,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    -

    An object representing a simple array. +

    An object containing a simple array. More...

    #include <mrarray.h>

    @@ -114,7 +114,7 @@ Public Attributes  

    Detailed Description

    -

    An object representing a simple array.

    +

    An object containing a simple array.

    This object is used in several placed where functions need to return an array. The items of the array are typically IDs. To free an array object, use mrarray_unref().

    Member Function Documentation

    @@ -163,7 +163,7 @@ Public Attributes -
    Returns
    Returns the number of items in a mrarray_t object. 0 on errors or if the array is empty.
    +
    Returns
    Returns the number of items in a mrarray_t object. 0 on errors or if the array is empty.
    diff --git a/docs/html/structmrchatlist__t-members.html b/docs/html/structmrchatlist__t-members.html index b1eeba8c..d1b32f06 100644 --- a/docs/html/structmrchatlist__t-members.html +++ b/docs/html/structmrchatlist__t-members.html @@ -92,7 +92,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); mrchatlist_get_chat_id(mrchatlist_t *chatlist, size_t index)mrchatlist_t mrchatlist_get_cnt(mrchatlist_t *chatlist)mrchatlist_t mrchatlist_get_msg_id(mrchatlist_t *chatlist, size_t index)mrchatlist_t - mrchatlist_get_summary(mrchatlist_t *chatlist, size_t index, mrchat_t *chat)mrchatlist_t + mrchatlist_get_summary(mrchatlist_t *chatlist, size_t index, mrchat_t *chat)mrchatlist_t mrchatlist_unref(mrchatlist_t *chatlist)mrchatlist_t diff --git a/docs/html/structmrchatlist__t.html b/docs/html/structmrchatlist__t.html index 58a15a68..394cb4fb 100644 --- a/docs/html/structmrchatlist__t.html +++ b/docs/html/structmrchatlist__t.html @@ -109,9 +109,9 @@ Public Member Functions uint32_t mrchatlist_get_msg_id (mrchatlist_t *chatlist, size_t index)  Get a single message ID of a chatlist. More...
      -mrpoortext_t * mrchatlist_get_summary (mrchatlist_t *chatlist, size_t index, mrchat_t *chat) - Get a summary for a chatlist index. More...
    -  +mrlot_t * mrchatlist_get_summary (mrchatlist_t *chatlist, size_t index, mrchat_t *chat) + Get a summary for a chatlist index. More...
    +  @@ -248,12 +248,12 @@ Public Attributes - +

    Public Attributes

    - + @@ -279,23 +279,23 @@ Public Attributes

    Get a summary for a chatlist index.

    -

    The summary is returned by a mrpoortext_t object with the following fields:

    +

    The summary is returned by a mrlot_t object with the following fields:

      -
    • m_text1: contains the username or the strings "Me", "Draft" and so on. The string may be colored by having a look at m_text1_meaning. If there is no such name, the element is NULL (eg. for "No messages")
      • -
    • m_text1_meaning: one of the MR_TEXT1_* constants
      • -
    • m_text2: contains an excerpt of the message text or strings as "No messages". may be NULL of there is no such text (eg. for the archive)
      • -
    • m_timestamp: the timestamp of the message. May be 0 if there is no message
      • -
    • m_state: the state of the message as one of the MR_STATE_* identifiers. 0 if there is no message.
      • +
    • mrlot_t::m_text1: contains the username or the strings "Me", "Draft" and so on. The string may be colored by having a look at m_text1_meaning. If there is no such name or it should not be displayed, the element is NULL.
      • +
    • mrlot_t::m_text1_meaning: one of MR_TEXT1_USERNAME, MR_TEXT1_SELF or MR_TEXT1_DRAFT. Typically used to show mrlot_t::m_text1 with different colors. 0 if not applicable.
      • +
    • mrlot_t::m_text2: contains an excerpt of the message text or strings as "No messages". May be NULL of there is no such text (eg. for the archive link)
      • +
    • mrlot_t::m_timestamp: the timestamp of the message. 0 if not applicable.
      • +
    • mrlot_t::m_state: The state of the message as one of the MR_STATE_* constants (see mrmsg_get_state()). 0 if not applicable.
    Parameters
    mrpoortext_t * mrchatlist_get_summary mrlot_t * mrchatlist_get_summary ( mrchatlist_t *  chatlist,
    - - - + + +
    chatlistThe chatlist to query as returned eg. from mrmailbox_get_chatlist().
    indexThe index to query in the chatlist.
    chatGiving the correct chat object here, this this will speed up things a little. If the chat object is not available by you, it is faster to pass NULL here.
    chatlistThe chatlist to query as returned eg. from mrmailbox_get_chatlist().
    indexThe index to query in the chatlist.
    chatTo speed up things, pass an already available chat object here. If the chat object is not yet available, it is faster to pass NULL.
    -
    Returns
    The result must be freed using mrpoortext_unref(). The function never returns NULL.
    +
    Returns
    The summary as an mrlot_t object. Must be freed using mrlot_unref(). NULL is never returned.
    diff --git a/docs/html/structmrlot__t-members.html b/docs/html/structmrlot__t-members.html new file mode 100644 index 00000000..06047e86 --- /dev/null +++ b/docs/html/structmrlot__t-members.html @@ -0,0 +1,105 @@ + + + + + + +Delta Chat Core C-API: Member List + + + + + + + + + + + +
    +
    + + + + + + +
    +
    Delta Chat Core C-API +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +
    mrlot_t Member List
    +
    +
    + +

    This is the complete list of members for mrlot_t, including all inherited members.

    + + + + + + + +
    m_statemrlot_t
    m_text1mrlot_t
    m_text1_meaningmrlot_t
    m_text2mrlot_t
    m_timestampmrlot_t
    mrlot_unref(mrlot_t *set)mrlot_t
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/structmrlot__t.html b/docs/html/structmrlot__t.html new file mode 100644 index 00000000..b84cbca4 --- /dev/null +++ b/docs/html/structmrlot__t.html @@ -0,0 +1,241 @@ + + + + + + +Delta Chat Core C-API: mrlot_t Struct Reference + + + + + + + + + + + +
    +
    + + + + + + +
    +
    Delta Chat Core C-API +
    +
    +
    + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +Public Member Functions | +Public Attributes | +List of all members
    +
    +
    mrlot_t Struct Reference
    +
    +
    + +

    An object containing a set of values. + More...

    + +

    #include <mrlot.h>

    + + + + + +

    +Public Member Functions

    void mrlot_unref (mrlot_t *set)
     Frees an object containing a set of parameters. More...
     
    + + + + + + + + + + + + + + + + +

    +Public Attributes

    int m_text1_meaning
     The meaning of this value is defined by the creator of the object. More...
     
    char * m_text1
     The meaning of this string is defined by the creator of the object. More...
     
    char * m_text2
     The meaning of this string is defined by the creator of the object. More...
     
    time_t m_timestamp
     The meaning of this value is defined by the creator of the object. More...
     
    int m_state
     The meaning of this value is defined by the creator of the object. More...
     
    +

    Detailed Description

    +

    An object containing a set of values.

    +

    The meaning of the values is defined by the function returning the set object. Set objects are created eg. by mrchatlist_get_summary(), mrmsg_get_summary() or by mrmsg_get_mediainfo().

    +

    NB: Lot is used in the meaning heap here.

    +

    Member Function Documentation

    + +
    +
    + + + + + + + + +
    void mrlot_unref (mrlot_t * set)
    +
    + +

    Frees an object containing a set of parameters.

    +

    If the set object contains strings, the strings are also freed with this function. Set objects are created eg. by mrchatlist_get_summary(), mrmsg_get_summary or by mrmsg_get_mediainfo().

    +
    Parameters
    + + +
    setThe object to free.
    +
    +
    +
    Returns
    None
    + +
    +
    +

    Member Data Documentation

    + +
    +
    + + + + +
    int mrlot_t::m_text1_meaning
    +
    + +

    The meaning of this value is defined by the creator of the object.

    +

    0 if not applicable.

    + +
    +
    + +
    +
    + + + + +
    char* mrlot_t::m_text1
    +
    + +

    The meaning of this string is defined by the creator of the object.

    +

    The string is freed with mrlot_unref(). NULL if not applicable.

    + +
    +
    + +
    +
    + + + + +
    char* mrlot_t::m_text2
    +
    + +

    The meaning of this string is defined by the creator of the object.

    +

    The string is freed with mrlot_unref(). NULL if not applicable.

    + +
    +
    + +
    +
    + + + + +
    time_t mrlot_t::m_timestamp
    +
    + +

    The meaning of this value is defined by the creator of the object.

    +

    0 if not applicable.

    + +
    +
    + +
    +
    + + + + +
    int mrlot_t::m_state
    +
    + +

    The meaning of this value is defined by the creator of the object.

    +

    0 if not applicable.

    + +
    +
    +
    The documentation for this struct was generated from the following files:
      +
    • /home/bpetersen/projects/deltachat-core/src/mrlot.h
      • +
    • /home/bpetersen/projects/deltachat-core/src/mrlot.c
      • +
    +
    + +
    +Generated by   +doxygen + 1.8.11 +
    + + diff --git a/docs/html/structmrmailbox__t.html b/docs/html/structmrmailbox__t.html index 610e4eca..5e1ba715 100644 --- a/docs/html/structmrmailbox__t.html +++ b/docs/html/structmrmailbox__t.html @@ -1239,7 +1239,7 @@ Public Attributes

    Search messages containing the given query string.

    Searching can be done globally (chat_id=0) or in a specified chat only (chat_id set).

    -

    Global chat results are typically displayed using mrmsg_get_summary(), chat search results may just hilite the corresponding messages and present a prev/next button.

    +

    Global chat results are typically displayed using mrmsg_get_summary(), chat search results may just hilite the corresponding messages and present a prev/next button.

    Parameters
    diff --git a/docs/html/structmrmsg__t-members.html b/docs/html/structmrmsg__t-members.html index 61fe098c..648258b4 100644 --- a/docs/html/structmrmsg__t-members.html +++ b/docs/html/structmrmsg__t-members.html @@ -98,10 +98,10 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); - + - + diff --git a/docs/html/structmrmsg__t.html b/docs/html/structmrmsg__t.html index d7d44f3f..a145ed11 100644 --- a/docs/html/structmrmsg__t.html +++ b/docs/html/structmrmsg__t.html @@ -124,9 +124,9 @@ Public Member Functions - - - + + + @@ -139,9 +139,9 @@ Public Member Functions - - - + + + @@ -425,12 +425,12 @@ Public Attributes - +
    mailboxThe mailbox object as returned from mrmailbox_new().
    mrmsg_get_filemime(mrmsg_t *msg)mrmsg_t
    mrmsg_get_filename(mrmsg_t *msg)mrmsg_t
    mrmsg_get_height(mrmsg_t *msg)mrmsg_t
    mrmsg_get_mediainfo(mrmsg_t *msg)mrmsg_t
    mrmsg_get_mediainfo(mrmsg_t *msg)mrmsg_t
    mrmsg_get_showpadlock(mrmsg_t *msg)mrmsg_t
    mrmsg_get_state(mrmsg_t *msg)mrmsg_t
    mrmsg_get_summary(mrmsg_t *msg, mrchat_t *chat)mrmsg_t
    mrmsg_get_summary(mrmsg_t *msg, mrchat_t *chat)mrmsg_t
    mrmsg_get_summarytext(mrmsg_t *msg, int approx_characters)mrmsg_t
    mrmsg_get_text(mrmsg_t *msg)mrmsg_t
    mrmsg_get_timestamp(mrmsg_t *msg)mrmsg_t
    uint64_t mrmsg_get_filebytes (mrmsg_t *msg)
     Get the size of the file. More...
     
    mrpoortext_t * mrmsg_get_mediainfo (mrmsg_t *msg)
     Get real author and title. More...
     
    mrlot_t * mrmsg_get_mediainfo (mrmsg_t *msg)
     Get real author and title. More...
     
    int mrmsg_get_width (mrmsg_t *msg)
     Get width of image or video. More...
     
    int mrmsg_get_showpadlock (mrmsg_t *msg)
     Check if a padlock should be shown beside the message. More...
     
    mrpoortext_t * mrmsg_get_summary (mrmsg_t *msg, mrchat_t *chat)
     Get a summary for a message. More...
     
    mrlot_t * mrmsg_get_summary (mrmsg_t *msg, mrchat_t *chat)
     Get a summary for a message. More...
     
    char * mrmsg_get_summarytext (mrmsg_t *msg, int approx_characters)
     Get a message summary as a single line of text. More...
     
    - + @@ -440,17 +440,19 @@ Public Attributes

    Get real author and title.

    +

    The information is returned by a mrlot_t object with the following fields:

      -
    • For voice messages, the author is the sender and the trackname is the sending time.
      • -
    • For music messages and videos, we read the information from the filename (we do not read ID3 and such at this stage, the needed libraries are too complicated and oversized. However, this is no big problem, as the sender usually sets the filename in a way we expect it)
      • +
    • mrlot_t::m_text1: Author of the media. For voice messages, this is the sender. For music messages, the information are read from the filename. NULL if unknown.
      • +
    • mrlot_t::m_text2: Title of the media. For voice messages, this is the date. For music messages, the information are read from the filename. NULL if unknown.
    +

    Currently, we do not read ID3 and such at this stage, the needed libraries are too complicated and oversized. However, this is no big problem, as the sender usually sets the filename in a way we expect it.

    Parameters
    mrpoortext_t * mrmsg_get_mediainfo mrlot_t * mrmsg_get_mediainfo ( mrmsg_t *  msg)
    msgThe message object.
    -
    Returns
    mrpoortext_t object that contains the author as mrpoortext_t::m_text1 and the title as mrpoortext_t::m_text2. Both may be NULL if unknown. The returned object must be freed using mrpoortext_unref() when no longer used.
    +
    Returns
    Media information as an mrlot_t object. Must be freed using mrlot_unref(). NULL is never returned.
    @@ -562,12 +564,12 @@ Public Attributes - +
    - + @@ -587,7 +589,15 @@ Public Attributes

    Get a summary for a message.

    -

    Typically used to display a search result.

    +

    The summary is returned by a mrlot_t object with the following fields:

    + +

    Typically used to display a search result. See also mrchatlist_get_summary() to display a list of chats.

    Parameters
    mrpoortext_t * mrmsg_get_summary mrlot_t * mrmsg_get_summary ( mrmsg_t *  msg,
    @@ -595,7 +605,7 @@ Public Attributes
    msgThe message object.
    -
    Returns
    The returned summary is similar to mrchatlist_get_summary(), however, without "draft", "no messages" and so on. The result must be freed using mrpoortext_unref().
    +
    Returns
    The summary as an mrlot_t object. Must be freed using mrlot_unref(). NULL is never returned.