mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-12-22 17:34:54 +01:00
lib: iterator API for message properties
This is a thin wrapper around the string map iterator API just introduced.
This commit is contained in:
parent
b846bdb482
commit
58fe8fce1d
3 changed files with 240 additions and 0 deletions
|
@ -106,3 +106,41 @@ notmuch_message_remove_all_properties (notmuch_message_t *message, const char *k
|
|||
|
||||
return NOTMUCH_STATUS_SUCCESS;
|
||||
}
|
||||
|
||||
notmuch_message_properties_t *
|
||||
notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact)
|
||||
{
|
||||
notmuch_string_map_t *map;
|
||||
map = _notmuch_message_property_map (message);
|
||||
return _notmuch_string_map_iterator_create (map, key, exact);
|
||||
}
|
||||
|
||||
notmuch_bool_t
|
||||
notmuch_message_properties_valid (notmuch_message_properties_t *properties)
|
||||
{
|
||||
return _notmuch_string_map_iterator_valid (properties);
|
||||
}
|
||||
|
||||
void
|
||||
notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties)
|
||||
{
|
||||
return _notmuch_string_map_iterator_move_to_next (properties);
|
||||
}
|
||||
|
||||
const char *
|
||||
notmuch_message_properties_key (notmuch_message_properties_t *properties)
|
||||
{
|
||||
return _notmuch_string_map_iterator_key (properties);
|
||||
}
|
||||
|
||||
const char *
|
||||
notmuch_message_properties_value (notmuch_message_properties_t *properties)
|
||||
{
|
||||
return _notmuch_string_map_iterator_value (properties);
|
||||
}
|
||||
|
||||
void
|
||||
notmuch_message_properties_destroy (notmuch_message_properties_t *properties)
|
||||
{
|
||||
_notmuch_string_map_iterator_destroy (properties);
|
||||
}
|
||||
|
|
|
@ -1723,6 +1723,101 @@ notmuch_message_remove_property (notmuch_message_t *message, const char *key, co
|
|||
notmuch_status_t
|
||||
notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key);
|
||||
|
||||
/**
|
||||
* Opaque message property iterator
|
||||
*/
|
||||
typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
|
||||
|
||||
/**
|
||||
* Get the properties for *message*, returning a
|
||||
* notmuch_message_properties_t object which can be used to iterate
|
||||
* over all properties.
|
||||
*
|
||||
* The notmuch_message_properties_t object is owned by the message and
|
||||
* as such, will only be valid for as long as the message is valid,
|
||||
* (which is until the query from which it derived is destroyed).
|
||||
*
|
||||
* @param[in] message The message to examine
|
||||
* @param[in] key key or key prefix
|
||||
* @param[in] exact if TRUE, require exact match with key. Otherwise
|
||||
* treat as prefix.
|
||||
*
|
||||
* Typical usage might be:
|
||||
*
|
||||
* notmuch_message_properties_t *list;
|
||||
*
|
||||
* for (list = notmuch_message_get_properties (message, "testkey1", TRUE);
|
||||
* notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
|
||||
* printf("%s\n", notmuch_message_properties_value(list));
|
||||
* }
|
||||
*
|
||||
* notmuch_message_properties_destroy (list);
|
||||
*
|
||||
* Note that there's no explicit destructor needed for the
|
||||
* notmuch_message_properties_t object. (For consistency, we do
|
||||
* provide a notmuch_message_properities_destroy function, but there's
|
||||
* no good reason to call it if the message is about to be destroyed).
|
||||
*/
|
||||
notmuch_message_properties_t *
|
||||
notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact);
|
||||
|
||||
/**
|
||||
* Is the given *properties* iterator pointing at a valid (key,value)
|
||||
* pair.
|
||||
*
|
||||
* When this function returns TRUE,
|
||||
* notmuch_message_properties_{key,value} will return a valid string,
|
||||
* and notmuch_message_properties_move_to_next will do what it
|
||||
* says. Whereas when this function returns FALSE, calling any of
|
||||
* these functions results in undefined behaviour.
|
||||
*
|
||||
* See the documentation of notmuch_message_properties_get for example
|
||||
* code showing how to iterate over a notmuch_message_properties_t
|
||||
* object.
|
||||
*/
|
||||
notmuch_bool_t
|
||||
notmuch_message_properties_valid (notmuch_message_properties_t *properties);
|
||||
|
||||
/**
|
||||
* Move the *properties* iterator to the next (key,value) pair
|
||||
*
|
||||
* If *properties* is already pointing at the last pair then the iterator
|
||||
* will be moved to a point just beyond that last pair, (where
|
||||
* notmuch_message_properties_valid will return FALSE).
|
||||
*
|
||||
* See the documentation of notmuch_message_get_properties for example
|
||||
* code showing how to iterate over a notmuch_message_properties_t object.
|
||||
*/
|
||||
void
|
||||
notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties);
|
||||
|
||||
/**
|
||||
* Return the key from the current (key,value) pair.
|
||||
*
|
||||
* this could be useful if iterating for a prefix
|
||||
*/
|
||||
const char *
|
||||
notmuch_message_properties_key (notmuch_message_properties_t *properties);
|
||||
|
||||
/**
|
||||
* Return the key from the current (key,value) pair.
|
||||
*
|
||||
* This could be useful if iterating for a prefix.
|
||||
*/
|
||||
const char *
|
||||
notmuch_message_properties_value (notmuch_message_properties_t *properties);
|
||||
|
||||
|
||||
/**
|
||||
* Destroy a notmuch_message_properties_t object.
|
||||
*
|
||||
* It's not strictly necessary to call this function. All memory from
|
||||
* the notmuch_message_properties_t object will be reclaimed when the
|
||||
* containing message object is destroyed.
|
||||
*/
|
||||
void
|
||||
notmuch_message_properties_destroy (notmuch_message_properties_t *properties);
|
||||
|
||||
/**@}*/
|
||||
|
||||
/**
|
||||
|
|
|
@ -9,8 +9,18 @@ cat <<EOF > c_head
|
|||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
#include <stdlib.h>
|
||||
#include <talloc.h>
|
||||
#include <notmuch-test.h>
|
||||
|
||||
void print_properties (notmuch_message_t *message, const char *prefix, notmuch_bool_t exact) {
|
||||
notmuch_message_properties_t *list;
|
||||
for (list = notmuch_message_get_properties (message, prefix, exact);
|
||||
notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
|
||||
printf("%s\n", notmuch_message_properties_value(list));
|
||||
}
|
||||
notmuch_message_properties_destroy (list);
|
||||
}
|
||||
|
||||
int main (int argc, char** argv)
|
||||
{
|
||||
notmuch_database_t *db;
|
||||
|
@ -79,6 +89,103 @@ testkey2 = NULL
|
|||
EOF
|
||||
test_expect_equal_file EXPECTED OUTPUT
|
||||
|
||||
test_begin_subtest "notmuch_message_get_properties: empty list"
|
||||
cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
|
||||
{
|
||||
notmuch_message_properties_t *list;
|
||||
list = notmuch_message_get_properties (message, "nonexistent", TRUE);
|
||||
printf("valid = %d\n", notmuch_message_properties_valid (list));
|
||||
notmuch_message_properties_destroy (list);
|
||||
}
|
||||
EOF
|
||||
cat <<'EOF' >EXPECTED
|
||||
== stdout ==
|
||||
valid = 0
|
||||
== stderr ==
|
||||
EOF
|
||||
test_expect_equal_file EXPECTED OUTPUT
|
||||
|
||||
test_begin_subtest "notmuch_message_properties: one value"
|
||||
cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
|
||||
print_properties (message, "testkey1", TRUE);
|
||||
EOF
|
||||
cat <<'EOF' >EXPECTED
|
||||
== stdout ==
|
||||
testvalue1
|
||||
== stderr ==
|
||||
EOF
|
||||
test_expect_equal_file EXPECTED OUTPUT
|
||||
|
||||
test_begin_subtest "notmuch_message_properties: multiple values"
|
||||
cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
|
||||
EXPECT0(notmuch_message_add_property (message, "testkey1", "bob"));
|
||||
EXPECT0(notmuch_message_add_property (message, "testkey1", "testvalue2"));
|
||||
EXPECT0(notmuch_message_add_property (message, "testkey1", "alice"));
|
||||
print_properties (message, "testkey1", TRUE);
|
||||
EOF
|
||||
cat <<'EOF' >EXPECTED
|
||||
== stdout ==
|
||||
alice
|
||||
bob
|
||||
testvalue1
|
||||
testvalue2
|
||||
== stderr ==
|
||||
EOF
|
||||
test_expect_equal_file EXPECTED OUTPUT
|
||||
|
||||
test_begin_subtest "notmuch_message_properties: prefix"
|
||||
cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
|
||||
EXPECT0(notmuch_message_add_property (message, "testkey3", "bob3"));
|
||||
EXPECT0(notmuch_message_add_property (message, "testkey3", "testvalue3"));
|
||||
EXPECT0(notmuch_message_add_property (message, "testkey3", "alice3"));
|
||||
print_properties (message, "testkey", FALSE);
|
||||
EOF
|
||||
cat <<'EOF' >EXPECTED
|
||||
== stdout ==
|
||||
alice
|
||||
bob
|
||||
testvalue1
|
||||
testvalue2
|
||||
alice3
|
||||
bob3
|
||||
testvalue3
|
||||
== stderr ==
|
||||
EOF
|
||||
test_expect_equal_file EXPECTED OUTPUT
|
||||
|
||||
test_begin_subtest "notmuch_message_properties: modify during iteration"
|
||||
cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR}
|
||||
{
|
||||
const char *keys[1000] = {NULL};
|
||||
const char *vals[1000] = {NULL};
|
||||
notmuch_message_properties_t *properties;
|
||||
int i;
|
||||
|
||||
for (properties = notmuch_message_get_properties (message, "", FALSE), i=0;
|
||||
notmuch_message_properties_valid (properties);
|
||||
notmuch_message_properties_move_to_next (properties), i++)
|
||||
{
|
||||
const char *key, *value;
|
||||
|
||||
keys[i]=talloc_strdup(message,
|
||||
notmuch_message_properties_key (properties));
|
||||
vals[i]=talloc_strdup(message,
|
||||
notmuch_message_properties_value (properties));
|
||||
|
||||
EXPECT0(notmuch_message_remove_property (message, keys[i], vals[i]));
|
||||
}
|
||||
|
||||
print_properties (message, "", FALSE);
|
||||
|
||||
for (i = 0; keys[i] && vals[i]; i++) {
|
||||
EXPECT0(notmuch_message_add_property (message, keys[i], vals[i]));
|
||||
}
|
||||
}
|
||||
EOF
|
||||
cat <<'EOF' >EXPECTED
|
||||
== stdout ==
|
||||
== stderr ==
|
||||
EOF
|
||||
test_expect_equal_file EXPECTED OUTPUT
|
||||
|
||||
test_done
|
||||
|
|
Loading…
Reference in a new issue