[thirdparty/cups.git] / scheduler / mime.h

/*
 * MIME type/conversion database definitions for CUPS.
 *
 * Copyright 2007-2013 by Apple Inc.
 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
 *
 * These coded instructions, statements, and computer programs are the
 * property of Apple Inc. and are protected by Federal copyright
 * law.  Distribution and use rights are outlined in the file "LICENSE.txt"
 * which should have been included with this file.  If this file is
 * missing or damaged, see the license at "http://www.cups.org/".
 */

#ifndef _CUPS_MIME_H_
#  define _CUPS_MIME_H_

#  include <cups/array.h>
#  include <cups/ipp.h>
#  include <cups/file.h>
#  include <regex.h>


/*
 * C++ magic...
 */

#  ifdef __cplusplus
extern "C" {
#  endif /* __cplusplus */


/*
 * Constants...
 */

#  define MIME_MAX_SUPER	16		/* Maximum size of supertype name */
#  define MIME_MAX_TYPE		IPP_MAX_NAME	/* Maximum size of type name */
#  define MIME_MAX_FILTER	256		/* Maximum size of filter pathname */
#  define MIME_MAX_BUFFER	4096		/* Maximum size of file buffer */


/*
 * Types/structures...
 */

typedef enum
{
  MIME_MAGIC_NOP,			/* No operation */
  MIME_MAGIC_AND,			/* Logical AND of all children */
  MIME_MAGIC_OR,			/* Logical OR of all children */
  MIME_MAGIC_MATCH,			/* Filename match */
  MIME_MAGIC_ASCII,			/* ASCII characters in range */
  MIME_MAGIC_PRINTABLE,			/* Printable characters (32-255) in range */
  MIME_MAGIC_STRING,			/* String matches */
  MIME_MAGIC_CHAR,			/* Character/byte matches */
  MIME_MAGIC_SHORT,			/* Short/16-bit word matches */
  MIME_MAGIC_INT,			/* Integer/32-bit word matches */
  MIME_MAGIC_LOCALE,			/* Current locale matches string */
  MIME_MAGIC_CONTAINS,			/* File contains a string */
  MIME_MAGIC_ISTRING,			/* Case-insensitive string matches */
  MIME_MAGIC_REGEX			/* Regular expression matches */
} mime_op_t;

typedef struct _mime_magic_s		/**** MIME Magic Data ****/
{
  struct _mime_magic_s	*prev,		/* Previous rule */
			*next,		/* Next rule */
			*parent,	/* Parent rules */
			*child;		/* Child rules */
  short		op,			/* Operation code (see above) */
		invert;			/* Invert the result */
  int		offset,			/* Offset in file */
		region,			/* Region length */
		length;			/* Length of data */
  union
  {
    char	matchv[64];		/* Match value */
    char	localev[64];		/* Locale value */
    char	stringv[64];		/* String value */
    unsigned char charv;		/* Byte value */
    unsigned short shortv;		/* Short value */
    unsigned	intv;			/* Integer value */
    regex_t	rev;			/* Regular expression value */
  }		value;
} mime_magic_t;

typedef struct _mime_type_s		/**** MIME Type Data ****/
{
  mime_magic_t	*rules;			/* Rules used to detect this type */
  int		priority;		/* Priority of this type */
  char		super[MIME_MAX_SUPER],	/* Super-type name ("image", "application", etc.) */
		type[MIME_MAX_TYPE];	/* Type name ("png", "postscript", etc.) */
} mime_type_t;

typedef struct _mime_filter_s		/**** MIME Conversion Filter Data ****/
{
  mime_type_t	*src,			/* Source type */
		*dst;			/* Destination type */
  int		cost;			/* Relative cost */
  char		filter[MIME_MAX_FILTER];/* Filter program to use */
  size_t	maxsize;		/* Maximum file size for this filter */
} mime_filter_t;

typedef void (*mime_error_cb_t)(void *ctx, const char *message);

typedef struct _mime_s			/**** MIME Database ****/
{
  cups_array_t		*types;		/* File types */
  cups_array_t		*filters;	/* Type conversion filters */
  cups_array_t		*srcs;		/* Filters sorted by source type */
  mime_error_cb_t	error_cb;	/* Error message callback */
  void			*error_ctx;	/* Pointer for callback */
} mime_t;


/*
 * Functions...
 */

extern void		mimeDelete(mime_t *mime);
extern mime_t		*mimeNew(void) _CUPS_API_1_5;
extern mime_t		*mimeLoad(const char *pathname, const char *filterpath);
extern mime_t		*mimeLoadFilters(mime_t *mime, const char *pathname,
			                 const char *filterpath);
extern mime_t		*mimeLoadTypes(mime_t *mime, const char *pathname);

extern mime_type_t	*mimeAddType(mime_t *mime, const char *super,
			             const char *type);
extern int		mimeAddTypeRule(mime_type_t *mt, const char *rule);
extern void		mimeDeleteType(mime_t *mime, mime_type_t *mt);
extern mime_type_t	*mimeFileType(mime_t *mime, const char *pathname,
			              const char *filename, int *compression);
extern mime_type_t	*mimeFirstType(mime_t *mime);
extern mime_type_t	*mimeNextType(mime_t *mime);
extern int		mimeNumTypes(mime_t *mime);
extern mime_type_t	*mimeType(mime_t *mime, const char *super,
				  const char *type);

extern mime_filter_t	*mimeAddFilter(mime_t *mime, mime_type_t *src,
			               mime_type_t *dst, int cost,
				       const char *filter);
extern void		mimeDeleteFilter(mime_t *mime, mime_filter_t *filter);
extern cups_array_t	*mimeFilter(mime_t *mime, mime_type_t *src,
			            mime_type_t *dst, int *cost);
extern cups_array_t	*mimeFilter2(mime_t *mime, mime_type_t *src,
			             size_t srcsize, mime_type_t *dst,
				     int *cost);
extern mime_filter_t	*mimeFilterLookup(mime_t *mime, mime_type_t *src,
			                  mime_type_t *dst);
extern mime_filter_t	*mimeFirstFilter(mime_t *mime);
extern mime_filter_t	*mimeNextFilter(mime_t *mime);
extern int		mimeNumFilters(mime_t *mime);
extern void		mimeSetErrorCallback(mime_t *mime, mime_error_cb_t cb,
			                     void *context) _CUPS_API_1_5;

#  ifdef __cplusplus
}
#  endif /* __cplusplus */
#endif /* !_CUPS_MIME_H_ */
Commit	Line	Data
ef416fc2	1	/*
503b54c9	2	* MIME type/conversion database definitions for CUPS.
ef416fc2	3	*
503b54c9 MS	4	* Copyright 2007-2013 by Apple Inc.
503b54c9 MS	5	* Copyright 1997-2007 by Easy Software Products, all rights reserved.
ef416fc2	6	*
503b54c9 MS	7	* These coded instructions, statements, and computer programs are the
	8	* property of Apple Inc. and are protected by Federal copyright
	9	* law. Distribution and use rights are outlined in the file "LICENSE.txt"
	10	* which should have been included with this file. If this file is
57b7b66b	11	* missing or damaged, see the license at "http://www.cups.org/".
ef416fc2	12	*/
	13
	14	#ifndef _CUPS_MIME_H_
	15	# define _CUPS_MIME_H_
	16
fa73b229	17	# include <cups/array.h>
ef416fc2	18	# include <cups/ipp.h>
ef416fc2	19	# include <cups/file.h>
6ee54c07	20	# include <regex.h>
ef416fc2	21
	22
	23	/*
	24	* C++ magic...
	25	*/
	26
d09495fa	27	# ifdef __cplusplus
ef416fc2	28	extern "C" {
d09495fa	29	# endif /* __cplusplus */
ef416fc2	30
	31
	32	/*
	33	* Constants...
	34	*/
	35
	36	# define MIME_MAX_SUPER 16 /* Maximum size of supertype name */
	37	# define MIME_MAX_TYPE IPP_MAX_NAME /* Maximum size of type name */
	38	# define MIME_MAX_FILTER 256 /* Maximum size of filter pathname */
4400e98d	39	# define MIME_MAX_BUFFER 4096 /* Maximum size of file buffer */
ef416fc2	40
	41
	42	/*
	43	* Types/structures...
	44	*/
	45
	46	typedef enum
	47	{
	48	MIME_MAGIC_NOP, /* No operation */
	49	MIME_MAGIC_AND, /* Logical AND of all children */
	50	MIME_MAGIC_OR, /* Logical OR of all children */
	51	MIME_MAGIC_MATCH, /* Filename match */
	52	MIME_MAGIC_ASCII, /* ASCII characters in range */
	53	MIME_MAGIC_PRINTABLE, /* Printable characters (32-255) in range */
	54	MIME_MAGIC_STRING, /* String matches */
	55	MIME_MAGIC_CHAR, /* Character/byte matches */
	56	MIME_MAGIC_SHORT, /* Short/16-bit word matches */
	57	MIME_MAGIC_INT, /* Integer/32-bit word matches */
	58	MIME_MAGIC_LOCALE, /* Current locale matches string */
	59	MIME_MAGIC_CONTAINS, /* File contains a string */
6ee54c07 MS	60	MIME_MAGIC_ISTRING, /* Case-insensitive string matches */
6ee54c07 MS	61	MIME_MAGIC_REGEX /* Regular expression matches */
ef416fc2	62	} mime_op_t;
ef416fc2	63
4400e98d	64	typedef struct _mime_magic_s /** MIME Magic Data **/
ef416fc2	65	{
bd7854cb	66	struct _mime_magic_s prev, / Previous rule */
ef416fc2	67	next, / Next rule */
	68	parent, / Parent rules */
	69	child; / Child rules */
	70	short op, /* Operation code (see above) */
	71	invert; /* Invert the result */
	72	int offset, /* Offset in file */
	73	region, /* Region length */
	74	length; /* Length of data */
	75	union
	76	{
	77	char matchv[64]; /* Match value */
	78	char localev[64]; /* Locale value */
	79	char stringv[64]; /* String value */
cc754834 MS	80	unsigned char charv; /* Byte value */
	81	unsigned short shortv; /* Short value */
	82	unsigned intv; /* Integer value */
6ee54c07	83	regex_t rev; /* Regular expression value */
ef416fc2	84	} value;
	85	} mime_magic_t;
	86
4400e98d	87	typedef struct _mime_type_s /** MIME Type Data **/
ef416fc2	88	{
ef416fc2	89	mime_magic_t rules; / Rules used to detect this type */
dd1abb6b	90	int priority; /* Priority of this type */
fa73b229	91	char super[MIME_MAX_SUPER], /* Super-type name ("image", "application", etc.) */
fa73b229	92	type[MIME_MAX_TYPE]; /* Type name ("png", "postscript", etc.) */
ef416fc2	93	} mime_type_t;
ef416fc2	94
4400e98d	95	typedef struct _mime_filter_s /** MIME Conversion Filter Data **/
ef416fc2	96	{
	97	mime_type_t src, / Source type */
	98	dst; / Destination type */
	99	int cost; /* Relative cost */
	100	char filter[MIME_MAX_FILTER];/* Filter program to use */
07ed0e9a	101	size_t maxsize; /* Maximum file size for this filter */
ef416fc2	102	} mime_filter_t;
ef416fc2	103
eac3a0a0 MS	104	typedef void (mime_error_cb_t)(void ctx, const char *message);
eac3a0a0 MS	105
4400e98d	106	typedef struct _mime_s /** MIME Database **/
ef416fc2	107	{
eac3a0a0 MS	108	cups_array_t types; / File types */
	109	cups_array_t filters; / Type conversion filters */
	110	cups_array_t srcs; / Filters sorted by source type */
	111	mime_error_cb_t error_cb; /* Error message callback */
	112	void error_ctx; / Pointer for callback */
ef416fc2	113	} mime_t;
	114
	115
	116	/*
	117	* Functions...
	118	*/
	119
	120	extern void mimeDelete(mime_t *mime);
eac3a0a0	121	extern mime_t *mimeNew(void) _CUPS_API_1_5;
fa73b229	122	extern mime_t mimeLoad(const char pathname, const char *filterpath);
75bd9771 MS	123	extern mime_t mimeLoadFilters(mime_t mime, const char *pathname,
	124	const char *filterpath);
	125	extern mime_t mimeLoadTypes(mime_t mime, const char *pathname);
ef416fc2	126
fa73b229	127	extern mime_type_t mimeAddType(mime_t mime, const char *super,
fa73b229	128	const char *type);
ef416fc2	129	extern int mimeAddTypeRule(mime_type_t mt, const char rule);
fa73b229	130	extern void mimeDeleteType(mime_t mime, mime_type_t mt);
ef416fc2	131	extern mime_type_t mimeFileType(mime_t mime, const char *pathname,
4400e98d	132	const char filename, int compression);
fa73b229	133	extern mime_type_t mimeFirstType(mime_t mime);
	134	extern mime_type_t mimeNextType(mime_t mime);
	135	extern int mimeNumTypes(mime_t *mime);
	136	extern mime_type_t mimeType(mime_t mime, const char *super,
	137	const char *type);
	138
	139	extern mime_filter_t mimeAddFilter(mime_t mime, mime_type_t *src,
	140	mime_type_t *dst, int cost,
	141	const char *filter);
	142	extern void mimeDeleteFilter(mime_t mime, mime_filter_t filter);
	143	extern cups_array_t mimeFilter(mime_t mime, mime_type_t *src,
bd7854cb	144	mime_type_t dst, int cost);
07ed0e9a MS	145	extern cups_array_t mimeFilter2(mime_t mime, mime_type_t *src,
	146	size_t srcsize, mime_type_t *dst,
	147	int *cost);
f7deaa1a	148	extern mime_filter_t mimeFilterLookup(mime_t mime, mime_type_t *src,
f7deaa1a	149	mime_type_t *dst);
fa73b229	150	extern mime_filter_t mimeFirstFilter(mime_t mime);
	151	extern mime_filter_t mimeNextFilter(mime_t mime);
	152	extern int mimeNumFilters(mime_t *mime);
eac3a0a0 MS	153	extern void mimeSetErrorCallback(mime_t *mime, mime_error_cb_t cb,
eac3a0a0 MS	154	void *context) _CUPS_API_1_5;
ef416fc2	155
d09495fa	156	# ifdef __cplusplus
ef416fc2	157	}
d09495fa	158	# endif /* __cplusplus */
ef416fc2	159	#endif /* !_CUPS_MIME_H_ */