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     void (*part_end) (GMimeObject *part);
  71     const char *part_sep;
  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     int raw;
  81 } notmuch_show_params_t;
  82
  83 /* There's no point in continuing when we've detected that we've done
  84  * something wrong internally (as opposed to the user passing in a
  85  * bogus value).
  86  *
  87  * Note that __location__ comes from talloc.h.
  88  */
  89 #define INTERNAL_ERROR(format, ...)                     \
  90     do {                                                \
  91         fprintf(stderr,                                 \
  92                 "Internal error: " format " (%s)\n",    \
  93                 ##__VA_ARGS__, __location__);           \
  94         exit (1);                                       \
  95     } while (0)
  96
  97 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
  98
  99 #define STRNCMP_LITERAL(var, literal) \
 100     strncmp ((var), (literal), sizeof (literal) - 1)
 101
 102 static inline void
 103 chomp_newline (char *str)
 104 {
 105     if (str && str[strlen(str)-1] == '\n')
 106         str[strlen(str)-1] = '\0';
 107 }
 108
 109 int
 110 notmuch_count_command (void *ctx, int argc, char *argv[]);
 111
 112 int
 113 notmuch_dump_command (void *ctx, int argc, char *argv[]);
 114
 115 int
 116 notmuch_new_command (void *ctx, int argc, char *argv[]);
 117
 118 int
 119 notmuch_reply_command (void *ctx, int argc, char *argv[]);
 120
 121 int
 122 notmuch_restore_command (void *ctx, int argc, char *argv[]);
 123
 124 int
 125 notmuch_search_command (void *ctx, int argc, char *argv[]);
 126
 127 int
 128 notmuch_setup_command (void *ctx, int argc, char *argv[]);
 129
 130 int
 131 notmuch_show_command (void *ctx, int argc, char *argv[]);
 132
 133 int
 134 notmuch_tag_command (void *ctx, int argc, char *argv[]);
 135
 136 int
 137 notmuch_search_tags_command (void *ctx, int argc, char *argv[]);
 138
 139 int
 140 notmuch_cat_command (void *ctx, int argc, char *argv[]);
 141
 142 int
 143 notmuch_part_command (void *ctx, int argc, char *argv[]);
 144
 145 int
 146 notmuch_config_command (void *ctx, int argc, char *argv[]);
 147
 148 const char *
 149 notmuch_time_relative_date (const void *ctx, time_t then);
 150
 151 void
 152 notmuch_time_print_formatted_seconds (double seconds);
 153
 154 double
 155 notmuch_time_elapsed (struct timeval start, struct timeval end);
 156
 157 char *
 158 query_string_from_args (void *ctx, int argc, char *argv[]);
 159
 160 notmuch_status_t
 161 show_message_body (const char *filename,
 162                    const notmuch_show_format_t *format);
 163
 164 notmuch_status_t
 165 show_one_part (const char *filename, int part);
 166
 167 char *
 168 json_quote_chararray (const void *ctx, const char *str, const size_t len);
 169
 170 char *
 171 json_quote_str (const void *ctx, const char *str);
 172
 173 /* notmuch-config.c */
 174
 175 typedef struct _notmuch_config notmuch_config_t;
 176
 177 notmuch_config_t *
 178 notmuch_config_open (void *ctx,
 179                      const char *filename,
 180                      notmuch_bool_t *is_new_ret);
 181
 182 void
 183 notmuch_config_close (notmuch_config_t *config);
 184
 185 int
 186 notmuch_config_save (notmuch_config_t *config);
 187
 188 const char *
 189 notmuch_config_get_database_path (notmuch_config_t *config);
 190
 191 void
 192 notmuch_config_set_database_path (notmuch_config_t *config,
 193                                   const char *database_path);
 194
 195 const char *
 196 notmuch_config_get_user_name (notmuch_config_t *config);
 197
 198 void
 199 notmuch_config_set_user_name (notmuch_config_t *config,
 200                               const char *user_name);
 201
 202 const char *
 203 notmuch_config_get_user_primary_email (notmuch_config_t *config);
 204
 205 void
 206 notmuch_config_set_user_primary_email (notmuch_config_t *config,
 207                                        const char *primary_email);
 208
 209 const char **
 210 notmuch_config_get_user_other_email (notmuch_config_t *config,
 211                                      size_t *length);
 212
 213 void
 214 notmuch_config_set_user_other_email (notmuch_config_t *config,
 215                                      const char *other_email[],
 216                                      size_t length);
 217
 218 const char **
 219 notmuch_config_get_new_tags (notmuch_config_t *config,
 220                              size_t *length);
 221 void
 222 notmuch_config_set_new_tags (notmuch_config_t *config,
 223                              const char *new_tags[],
 224                              size_t length);
 225
 226 notmuch_bool_t
 227 notmuch_config_get_maildir_synchronize_flags (notmuch_config_t *config);
 228
 229 void
 230 notmuch_config_set_maildir_synchronize_flags (notmuch_config_t *config,
 231                                               notmuch_bool_t synchronize_flags);
 232
 233 notmuch_bool_t
 234 debugger_is_active (void);
 235
 236 #endif