cups/mime.h

   1 /*
   2  * "$Id: mime.h,v 1.7 2000/01/04 13:45:35 mike Exp $"
   3  *
   4  *   MIME type/conversion database definitions for the Common UNIX Printing System (CUPS).
   5  *
   6  *   Copyright 1997-2000 by Easy Software Products, all rights reserved.
   7  *
   8  *   These coded instructions, statements, and computer programs are the
   9  *   property of Easy Software Products and are protected by Federal
  10  *   copyright law.  Distribution and use rights are outlined in the file
  11  *   "LICENSE.txt" which should have been included with this file.  If this
  12  *   file is missing or damaged please contact Easy Software Products
  13  *   at:
  14  *
  15  *       Attn: CUPS Licensing Information
  16  *       Easy Software Products
  17  *       44141 Airport View Drive, Suite 204
  18  *       Hollywood, Maryland 20636-3111 USA
  19  *
  20  *       Voice: (301) 373-9603
  21  *       EMail: cups-info@cups.org
  22  *         WWW: http://www.cups.org
  23  */
  24
  25 #ifndef _MIME_H_
  26 #  define _MIME_H_
  27
  28 /*
  29  * C++ magic...
  30  */
  31
  32 #  ifdef _cplusplus
  33 extern "C" {
  34 #  endif /* _cplusplus */
  35
  36
  37 /*
  38  * Constants...
  39  */
  40
  41 #  define MIME_MAX_SUPER        16      /* Maximum size of supertype name */
  42 #  define MIME_MAX_TYPE         32      /* Maximum size of type name */
  43 #  define MIME_MAX_FILTER       256     /* Maximum size of filter pathname */
  44 #  define MIME_MAX_BUFFER       8192    /* Maximum size of file buffer */
  45
  46
  47 /*
  48  * Types/structures...
  49  */
  50
  51 typedef enum
  52 {
  53   MIME_MAGIC_NOP,       /* No operation */
  54   MIME_MAGIC_AND,       /* Logical AND of all children */
  55   MIME_MAGIC_OR,        /* Logical OR of all children */
  56   MIME_MAGIC_MATCH,     /* Filename match */
  57   MIME_MAGIC_ASCII,     /* ASCII characters in range */
  58   MIME_MAGIC_PRINTABLE, /* Printable characters (32-255) in range */
  59   MIME_MAGIC_STRING,    /* String matches */
  60   MIME_MAGIC_CHAR,      /* Character/byte matches */
  61   MIME_MAGIC_SHORT,     /* Short/16-bit word matches */
  62   MIME_MAGIC_INT,       /* Integer/32-bit word matches */
  63   MIME_MAGIC_LOCALE     /* Current locale matches string */
  64 } mime_op_t;
  65
  66 typedef struct mime_magic_str           /**** MIME Magic Data ****/
  67 {
  68   struct mime_magic_str *prev,          /* Previous rule */
  69                         *next,          /* Next rule */
  70                         *parent,        /* Parent rules */
  71                         *child;         /* Child rules */
  72   short         op,                     /* Operation code (see above) */
  73                 invert;                 /* Invert the result */
  74   int           offset,                 /* Offset in file */
  75                 length;                 /* Length of data */
  76   union
  77   {
  78     char        matchv[64];             /* Match value */
  79     char        localev[64];            /* Locale value */
  80     char        stringv[64];            /* String value */
  81     char        charv;                  /* Byte value */
  82     short       shortv;                 /* Short value */
  83     int         intv;                   /* Integer value */
  84   }             value;
  85 } mime_magic_t;
  86
  87 typedef struct                          /**** MIME Type Data ****/
  88 {
  89   char          super[MIME_MAX_SUPER],  /* Super-type name ("image", "application", etc.) */
  90                 type[MIME_MAX_TYPE];    /* Type name ("png", "postscript", etc.) */
  91   mime_magic_t  *rules;                 /* Rules used to detect this type */
  92 } mime_type_t;
  93
  94 typedef struct                          /**** MIME Conversion Filter Data ****/
  95 {
  96   mime_type_t   *src,                   /* Source type */
  97                 *dst;                   /* Destination type */
  98   int           cost;                   /* Relative cost */
  99   char          filter[MIME_MAX_FILTER];/* Filter program to use */
 100 } mime_filter_t;
 101
 102 typedef struct                          /**** MIME Database ****/
 103 {
 104   int           num_types;              /* Number of file types */
 105   mime_type_t   **types;                /* File types */
 106   int           num_filters;            /* Number of type conversion filters */
 107   mime_filter_t *filters;               /* Type conversion filters */
 108 } mime_t;
 109
 110
 111 /*
 112  * Functions...
 113  */
 114
 115 extern void             mimeDelete(mime_t *mime);
 116 #define mimeLoad(pathname)      mimeMerge((mime_t *)0, (pathname));
 117 extern mime_t           *mimeMerge(mime_t *mime, const char *pathname);
 118 extern mime_t           *mimeNew(void);
 119
 120 extern mime_type_t      *mimeAddType(mime_t *mime, const char *super, const char *type);
 121 extern int              mimeAddTypeRule(mime_type_t *mt, const char *rule);
 122 extern mime_type_t      *mimeFileType(mime_t *mime, const char *pathname);
 123 extern mime_type_t      *mimeType(mime_t *mime, const char *super, const char *type);
 124
 125 extern mime_filter_t    *mimeAddFilter(mime_t *mime, mime_type_t *src, mime_type_t *dst,
 126                                        int cost, const char *filter);
 127 extern mime_filter_t    *mimeFilter(mime_t *mime, mime_type_t *src, mime_type_t *dst,
 128                                     int *num_filters);
 129
 130 #  ifdef _cplusplus
 131 }
 132 #  endif /* _cplusplus */
 133 #endif /* !_MIME_H_ */
 134
 135 /*
 136  * End of "$Id: mime.h,v 1.7 2000/01/04 13:45:35 mike Exp $".
 137  */