git.notmuchmail.org Git - notmuch/blob - notmuch-client.h

   1 /* notmuch - Not much of an email program, (just index and search)
   2  *
   3  * Copyright © 2009 Carl Worth
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see http://www.gnu.org/licenses/ .
  17  *
  18  * Author: Carl Worth <cworth@cworth.org>
  19  */
  20
  21 #ifndef NOTMUCH_CLIENT_H
  22 #define NOTMUCH_CLIENT_H
  23
  24 #ifndef _GNU_SOURCE
  25 #define _GNU_SOURCE /* for getline */
  26 #endif
  27 #include <stdio.h>
  28
  29 #include "compat.h"
  30
  31 #include <gmime/gmime.h>
  32
  33 #include "notmuch.h"
  34
  35 /* This is separate from notmuch-private.h because we're trying to
  36  * keep notmuch.c from looking into any internals, (which helps us
  37  * develop notmuch.h into a plausible library interface).
  38  */
  39 #include "xutil.h"
  40
  41 #include <stddef.h>
  42 #include <string.h>
  43 #include <sys/stat.h>
  44 #include <sys/time.h>
  45 #include <unistd.h>
  46 #include <dirent.h>
  47 #include <errno.h>
  48 #include <signal.h>
  49
  50 #include <talloc.h>
  51
  52 #define unused(x) x __attribute__ ((unused))
  53
  54 #define STRINGIFY(s) STRINGIFY_(s)
  55 #define STRINGIFY_(s) #s
  56
  57 typedef struct notmuch_show_format {
  58     const char *message_set_start;
  59     const char *message_start;
  60     void (*message) (const void *ctx,
  61                      notmuch_message_t *message,
  62                      int indent);
  63     const char *header_start;
  64     void (*header) (const void *ctx,
  65                     notmuch_message_t *message);
  66     const char *header_end;
  67     const char *body_start;
  68     void (*part) (GMimeObject *part,
  69                   int *part_count,
  70                   int first);
  71     void (*part_end) (GMimeObject *part);
  72     const char *body_end;
  73     const char *message_end;
  74     const char *message_set_sep;
  75     const char *message_set_end;
  76 } notmuch_show_format_t;
  77
  78 typedef struct notmuch_show_params {
  79     int entire_thread;
  80 } notmuch_show_params_t;
  81
  82 /* There's no point in continuing when we've detected that we've done
  83  * something wrong internally (as opposed to the user passing in a
  84  * bogus value).
  85  *
  86  * Note that __location__ comes from talloc.h.
  87  */
  88 #define INTERNAL_ERROR(format, ...)                     \
  89     do {                                                \
  90         fprintf(stderr,                                 \
  91                 "Internal error: " format " (%s)\n",    \
  92                 ##__VA_ARGS__, __location__);           \
  93         exit (1);                                       \
  94     } while (0)
  95
  96 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
  97
  98 #define STRNCMP_LITERAL(var, literal) \
  99     strncmp ((var), (literal), sizeof (literal) - 1)
 100
 101 static inline void
 102 chomp_newline (char *str)
 103 {
 104     if (str && str[strlen(str)-1] == '\n')
 105         str[strlen(str)-1] = '\0';
 106 }
 107
 108 int
 109 notmuch_count_command (void *ctx, int argc, char *argv[]);
 110
 111 int
 112 notmuch_dump_command (void *ctx, int argc, char *argv[]);
 113
 114 int
 115 notmuch_new_command (void *ctx, int argc, char *argv[]);
 116
 117 int
 118 notmuch_reply_command (void *ctx, int argc, char *argv[]);
 119
 120 int
 121 notmuch_restore_command (void *ctx, int argc, char *argv[]);
 122
 123 int
 124 notmuch_search_command (void *ctx, int argc, char *argv[]);
 125
 126 int
 127 notmuch_setup_command (void *ctx, int argc, char *argv[]);
 128
 129 int
 130 notmuch_show_command (void *ctx, int argc, char *argv[]);
 131
 132 int
 133 notmuch_tag_command (void *ctx, int argc, char *argv[]);
 134
 135 int
 136 notmuch_search_tags_command (void *ctx, int argc, char *argv[]);
 137
 138 int
 139 notmuch_cat_command (void *ctx, int argc, char *argv[]);
 140
 141 int
 142 notmuch_part_command (void *ctx, int argc, char *argv[]);
 143
 144 int
 145 notmuch_config_command (void *ctx, int argc, char *argv[]);
 146
 147 const char *
 148 notmuch_time_relative_date (const void *ctx, time_t then);
 149
 150 void
 151 notmuch_time_print_formatted_seconds (double seconds);
 152
 153 double
 154 notmuch_time_elapsed (struct timeval start, struct timeval end);
 155
 156 char *
 157 query_string_from_args (void *ctx, int argc, char *argv[]);
 158
 159 notmuch_status_t
 160 show_message_body (const char *filename,
 161                    const notmuch_show_format_t *format);
 162
 163 notmuch_status_t
 164 show_one_part (const char *filename, int part);
 165
 166 char *
 167 json_quote_chararray (const void *ctx, const char *str, const size_t len);
 168
 169 char *
 170 json_quote_str (const void *ctx, const char *str);
 171
 172 /* notmuch-config.c */
 173
 174 typedef struct _notmuch_config notmuch_config_t;
 175
 176 notmuch_config_t *
 177 notmuch_config_open (void *ctx,
 178                      const char *filename,
 179                      notmuch_bool_t *is_new_ret);
 180
 181 void
 182 notmuch_config_close (notmuch_config_t *config);
 183
 184 int
 185 notmuch_config_save (notmuch_config_t *config);
 186
 187 const char *
 188 notmuch_config_get_database_path (notmuch_config_t *config);
 189
 190 void
 191 notmuch_config_set_database_path (notmuch_config_t *config,
 192                                   const char *database_path);
 193
 194 const char *
 195 notmuch_config_get_user_name (notmuch_config_t *config);
 196
 197 void
 198 notmuch_config_set_user_name (notmuch_config_t *config,
 199                               const char *user_name);
 200
 201 const char *
 202 notmuch_config_get_user_primary_email (notmuch_config_t *config);
 203
 204 void
 205 notmuch_config_set_user_primary_email (notmuch_config_t *config,
 206                                        const char *primary_email);
 207
 208 const char **
 209 notmuch_config_get_user_other_email (notmuch_config_t *config,
 210                                      size_t *length);
 211
 212 void
 213 notmuch_config_set_user_other_email (notmuch_config_t *config,
 214                                      const char *other_email[],
 215                                      size_t length);
 216
 217 const char **
 218 notmuch_config_get_new_tags (notmuch_config_t *config,
 219                              size_t *length);
 220 void
 221 notmuch_config_set_new_tags (notmuch_config_t *config,
 222                              const char *new_tags[],
 223                              size_t length);
 224
 225 notmuch_bool_t
 226 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
 227
 228 void
 229 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
 230                                               notmuch_bool_t synchronize_flags);
 231
 232 notmuch_bool_t
 233 debugger_is_active (void);
 234
 235 #endif