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
  25 #ifndef _GNU_SOURCE
  26 #define _GNU_SOURCE /* for getline */
  27 #endif
  28 #include <stdio.h>
  29
  30 #include <gmime/gmime.h>
  31
  32 #include "notmuch.h"
  33
  34 /* This is separate from notmuch-private.h because we're trying to
  35  * keep notmuch.c from looking into any internals, (which helps us
  36  * develop notmuch.h into a plausible library interface).
  37  */
  38 #include "xutil.h"
  39
  40 #include <stddef.h>
  41 #include <string.h>
  42 #include <sys/stat.h>
  43 #include <sys/time.h>
  44 #include <unistd.h>
  45 #include <dirent.h>
  46 #include <errno.h>
  47 #include <signal.h>
  48
  49 #include <talloc.h>
  50
  51 #define unused(x) x __attribute__ ((unused))
  52
  53 /* There's no point in continuing when we've detected that we've done
  54  * something wrong internally (as opposed to the user passing in a
  55  * bogus value).
  56  *
  57  * Note that __location__ comes from talloc.h.
  58  */
  59 #define INTERNAL_ERROR(format, ...)                     \
  60     do {                                                \
  61         fprintf(stderr,                                 \
  62                 "Internal error: " format " (%s)\n",    \
  63                 ##__VA_ARGS__, __location__);           \
  64         exit (1);                                       \
  65     } while (0)
  66
  67 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
  68
  69 #define STRNCMP_LITERAL(var, literal) \
  70     strncmp ((var), (literal), sizeof (literal) - 1)
  71
  72 typedef void (*add_files_callback_t) (notmuch_message_t *message);
  73
  74 typedef struct {
  75     int ignore_read_only_directories;
  76     int saw_read_only_directory;
  77     int output_is_a_tty;
  78     int verbose;
  79
  80     int total_files;
  81     int processed_files;
  82     int added_messages;
  83     struct timeval tv_start;
  84
  85     add_files_callback_t callback;
  86 } add_files_state_t;
  87
  88 static inline void
  89 chomp_newline (char *str)
  90 {
  91     if (str && str[strlen(str)-1] == '\n')
  92         str[strlen(str)-1] = '\0';
  93 }
  94
  95 int
  96 notmuch_count_command (void *ctx, int argc, char *argv[]);
  97
  98 int
  99 notmuch_dump_command (void *ctx, int argc, char *argv[]);
 100
 101 int
 102 notmuch_new_command (void *ctx, int argc, char *argv[]);
 103
 104 int
 105 notmuch_reply_command (void *ctx, int argc, char *argv[]);
 106
 107 int
 108 notmuch_restore_command (void *ctx, int argc, char *argv[]);
 109
 110 int
 111 notmuch_search_command (void *ctx, int argc, char *argv[]);
 112
 113 int
 114 notmuch_setup_command (void *ctx, int argc, char *argv[]);
 115
 116 int
 117 notmuch_show_command (void *ctx, int argc, char *argv[]);
 118
 119 int
 120 notmuch_tag_command (void *ctx, int argc, char *argv[]);
 121
 122 const char *
 123 notmuch_time_relative_date (const void *ctx, time_t then);
 124
 125 void
 126 notmuch_time_print_formatted_seconds (double seconds);
 127
 128 double
 129 notmuch_time_elapsed (struct timeval start, struct timeval end);
 130
 131 notmuch_status_t
 132 add_files (notmuch_database_t *notmuch, const char *path,
 133            add_files_state_t *state);
 134
 135 char *
 136 query_string_from_args (void *ctx, int argc, char *argv[]);
 137
 138 notmuch_status_t
 139 show_message_body (const char *filename,
 140                    void (*show_part) (GMimeObject *part, int *part_count));
 141
 142 /* notmuch-config.c */
 143
 144 typedef struct _notmuch_config notmuch_config_t;
 145
 146 notmuch_config_t *
 147 notmuch_config_open (void *ctx,
 148                      const char *filename,
 149                      notmuch_bool_t *is_new_ret);
 150
 151 void
 152 notmuch_config_close (notmuch_config_t *config);
 153
 154 int
 155 notmuch_config_save (notmuch_config_t *config);
 156
 157 const char *
 158 notmuch_config_get_database_path (notmuch_config_t *config);
 159
 160 void
 161 notmuch_config_set_database_path (notmuch_config_t *config,
 162                                   const char *database_path);
 163
 164 const char *
 165 notmuch_config_get_user_name (notmuch_config_t *config);
 166
 167 void
 168 notmuch_config_set_user_name (notmuch_config_t *config,
 169                               const char *user_name);
 170
 171 const char *
 172 notmuch_config_get_user_primary_email (notmuch_config_t *config);
 173
 174 void
 175 notmuch_config_set_user_primary_email (notmuch_config_t *config,
 176                                        const char *primary_email);
 177
 178 char **
 179 notmuch_config_get_user_other_email (notmuch_config_t *config,
 180                                      size_t *length);
 181
 182 void
 183 notmuch_config_set_user_other_email (notmuch_config_t *config,
 184                                      const char *other_email[],
 185                                      size_t length);
 186
 187 notmuch_bool_t
 188 debugger_is_active (void);
 189
 190 #endif