]> git.ipfire.org Git - thirdparty/cups.git/blob - scheduler/mime.h
f536a68e72b6f5d2bb611a63d005cbb40c254f55
[thirdparty/cups.git] / scheduler / mime.h
1 /*
2 * MIME type/conversion database definitions for CUPS.
3 *
4 * Copyright 2007-2013 by Apple Inc.
5 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
6 *
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
11 * file is missing or damaged, see the license at "http://www.cups.org/".
12 */
13
14 #ifndef _CUPS_MIME_H_
15 # define _CUPS_MIME_H_
16
17 # include <cups/array.h>
18 # include <cups/ipp.h>
19 # include <cups/file.h>
20 # include <regex.h>
21
22
23 /*
24 * C++ magic...
25 */
26
27 # ifdef __cplusplus
28 extern "C" {
29 # endif /* __cplusplus */
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 */
39 # define MIME_MAX_BUFFER 4096 /* Maximum size of file buffer */
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 */
60 MIME_MAGIC_ISTRING, /* Case-insensitive string matches */
61 MIME_MAGIC_REGEX /* Regular expression matches */
62 } mime_op_t;
63
64 typedef struct _mime_magic_s /**** MIME Magic Data ****/
65 {
66 struct _mime_magic_s *prev, /* Previous rule */
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 */
80 unsigned char charv; /* Byte value */
81 unsigned short shortv; /* Short value */
82 unsigned intv; /* Integer value */
83 regex_t rev; /* Regular expression value */
84 } value;
85 } mime_magic_t;
86
87 typedef struct _mime_type_s /**** MIME Type Data ****/
88 {
89 mime_magic_t *rules; /* Rules used to detect this type */
90 int priority; /* Priority of this type */
91 char super[MIME_MAX_SUPER], /* Super-type name ("image", "application", etc.) */
92 type[MIME_MAX_TYPE]; /* Type name ("png", "postscript", etc.) */
93 } mime_type_t;
94
95 typedef struct _mime_filter_s /**** MIME Conversion Filter Data ****/
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 */
101 size_t maxsize; /* Maximum file size for this filter */
102 } mime_filter_t;
103
104 typedef void (*mime_error_cb_t)(void *ctx, const char *message);
105
106 typedef struct _mime_s /**** MIME Database ****/
107 {
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 */
113 } mime_t;
114
115
116 /*
117 * Functions...
118 */
119
120 extern void mimeDelete(mime_t *mime);
121 extern mime_t *mimeNew(void) _CUPS_API_1_5;
122 extern mime_t *mimeLoad(const char *pathname, const char *filterpath);
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);
126
127 extern mime_type_t *mimeAddType(mime_t *mime, const char *super,
128 const char *type);
129 extern int mimeAddTypeRule(mime_type_t *mt, const char *rule);
130 extern void mimeDeleteType(mime_t *mime, mime_type_t *mt);
131 extern mime_type_t *mimeFileType(mime_t *mime, const char *pathname,
132 const char *filename, int *compression);
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,
144 mime_type_t *dst, int *cost);
145 extern cups_array_t *mimeFilter2(mime_t *mime, mime_type_t *src,
146 size_t srcsize, mime_type_t *dst,
147 int *cost);
148 extern mime_filter_t *mimeFilterLookup(mime_t *mime, mime_type_t *src,
149 mime_type_t *dst);
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);
153 extern void mimeSetErrorCallback(mime_t *mime, mime_error_cb_t cb,
154 void *context) _CUPS_API_1_5;
155
156 # ifdef __cplusplus
157 }
158 # endif /* __cplusplus */
159 #endif /* !_CUPS_MIME_H_ */