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