gpgme/gpgme/context.h

/* context.h
   Copyright (C) 2000 Werner Koch (dd9jn)
   Copyright (C) 2001, 2002, 2003 g10 Code GmbH

   This file is part of GPGME.
 
   GPGME is free software; you can redistribute it and/or modify it
   under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
 
   GPGME is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with GPGME; if not, write to the Free Software Foundation,
   Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */

#ifndef CONTEXT_H
#define CONTEXT_H

#include "gpgme.h"
#include "engine.h"
#include "wait.h"


/* Operations might require to remember arbitrary information and data
   objects during invocations of the status handler.  The
   ctx_op_data structure provides a generic framework to hook in
   such additional data.  */
typedef enum
  {
    OPDATA_DECRYPT, OPDATA_SIGN, OPDATA_ENCRYPT, OPDATA_PASSPHRASE,
    OPDATA_IMPORT, OPDATA_GENKEY, OPDATA_KEYLIST, OPDATA_EDIT,
    OPDATA_VERIFY_COLLECTING, OPDATA_VERIFY
  } ctx_op_data_type;

struct ctx_op_data
{
  /* The next element in the linked list, or NULL if this is the last
     element.  */
  struct ctx_op_data *next;

  /* The type of the hook data, which can be used by a routine to
     lookup the hook data.  */
  ctx_op_data_type type;

  /* The function to release HOOK and all its associated resources.
     Can be NULL if no special dealllocation routine is necessary.  */
  void (*cleanup) (void *hook);

  /* The hook that points to the operation data.  */
  void *hook;
};


struct key_queue_item_s
{
  struct key_queue_item_s *next;
  GpgmeKey key;
};


struct trust_queue_item_s
{
  struct trust_queue_item_s *next;
  GpgmeTrustItem item;
};


/* Currently we need it at several places, so we put the definition
   into this header file.  */
struct gpgme_context_s
{
  /* The protocol used by this context.  */
  GpgmeProtocol protocol;

  /* The running engine process.  */
  EngineObject engine;

  /* True if armor mode should be used.  */
  unsigned int use_armor : 1;

  /* True if text mode should be used.  */
  unsigned int use_textmode : 1;

  /* Flags for keylist mode.  */
  unsigned int keylist_mode;

  /* Number of certs to be included.  */
  unsigned int include_certs;

  /* The number of keys in signers.  */
  unsigned int signers_len;

  /* Size of the following array.  */
  unsigned int signers_size;
  GpgmeKey *signers;

  /* The operation data hooked into the context.  */
  struct ctx_op_data *op_data;

  /* Last signature notation.  */
  GpgmeData notation;
  /* Last operation info.  */
  GpgmeData op_info;

  /* Used by keylist.c.  */
  GpgmeKey tmp_key;
  struct user_id_s *tmp_uid;
  /* Something new is available.  */
  volatile int key_cond;
  struct key_queue_item_s *key_queue;
  struct trust_queue_item_s *trust_queue;

  /* The user provided passphrase callback and its hook value.  */
  GpgmePassphraseCb passphrase_cb;
  void *passphrase_cb_value;

  /* The user provided progress callback and its hook value.  */
  GpgmeProgressCb progress_cb;
  void *progress_cb_value;

  /* A list of file descriptors in active use by the current
     operation.  */
  struct fd_table fdt;
  struct GpgmeIOCbs io_cbs;
};

/* Forward declaration of a structure to store certification
   signatures.  */
struct certsig_s;

/* Structure to store user IDs.  */
struct user_id_s
{
  struct user_id_s *next;
  unsigned int revoked : 1;
  unsigned int invalid : 1;
  GpgmeValidity validity; 
  struct certsig_s *certsigs;
  struct certsig_s *last_certsig;
  const char *name_part;	/* All 3 point into strings behind name  */
  const char *email_part;	/* or to read-only strings.  */
  const char *comment_part;
  char name[1];
};


struct gpgme_recipients_s
{
  struct user_id_s *list;
  int checked;	/* Whether the recipients are all valid.  */
};


#endif	/* CONTEXT_H */