xref: /PHP-7.2/ext/fileinfo/libmagic/magic.h (revision 08d8623d)
1 /*
2  * Copyright (c) Christos Zoulas 2003.
3  * All Rights Reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice immediately at the beginning of the file, without modification,
10  *    this list of conditions, and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
19  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 #ifndef _MAGIC_H
28 #define _MAGIC_H
29 
30 #include <sys/types.h>
31 
32 #define	MAGIC_NONE		0x0000000 /* No flags */
33 #define	MAGIC_DEBUG		0x0000001 /* Turn on debugging */
34 #define	MAGIC_SYMLINK		0x0000002 /* Follow symlinks */
35 #define	MAGIC_COMPRESS		0x0000004 /* Check inside compressed files */
36 #define	MAGIC_DEVICES		0x0000008 /* Look at the contents of devices */
37 #define	MAGIC_MIME_TYPE		0x0000010 /* Return the MIME type */
38 #define	MAGIC_CONTINUE		0x0000020 /* Return all matches */
39 #define	MAGIC_CHECK		0x0000040 /* Print warnings to stderr */
40 #define	MAGIC_PRESERVE_ATIME	0x0000080 /* Restore access time on exit */
41 #define	MAGIC_RAW		0x0000100 /* Don't convert unprintable chars */
42 #define	MAGIC_ERROR		0x0000200 /* Handle ENOENT etc as real errors */
43 #define	MAGIC_MIME_ENCODING	0x0000400 /* Return the MIME encoding */
44 #define MAGIC_MIME		(MAGIC_MIME_TYPE|MAGIC_MIME_ENCODING)
45 #define	MAGIC_APPLE		0x0000800 /* Return the Apple creator/type */
46 #define	MAGIC_EXTENSION		0x1000000 /* Return a /-separated list of
47 					   * extensions */
48 #define MAGIC_COMPRESS_TRANSP	0x2000000 /* Check inside compressed files
49 					   * but not report compression */
50 #define MAGIC_NODESC		(MAGIC_EXTENSION|MAGIC_MIME|MAGIC_APPLE)
51 
52 #define	MAGIC_NO_CHECK_COMPRESS	0x0001000 /* Don't check for compressed files */
53 #define	MAGIC_NO_CHECK_TAR	0x0002000 /* Don't check for tar files */
54 #define	MAGIC_NO_CHECK_SOFT	0x0004000 /* Don't check magic entries */
55 #define	MAGIC_NO_CHECK_APPTYPE	0x0008000 /* Don't check application type */
56 #define	MAGIC_NO_CHECK_ELF	0x0010000 /* Don't check for elf details */
57 #define	MAGIC_NO_CHECK_TEXT	0x0020000 /* Don't check for text files */
58 #define	MAGIC_NO_CHECK_CDF	0x0040000 /* Don't check for cdf files */
59 #define	MAGIC_NO_CHECK_TOKENS	0x0100000 /* Don't check tokens */
60 #define MAGIC_NO_CHECK_ENCODING 0x0200000 /* Don't check text encodings */
61 
62 /* No built-in tests; only consult the magic file */
63 #define MAGIC_NO_CHECK_BUILTIN	( \
64 	MAGIC_NO_CHECK_COMPRESS	| \
65 	MAGIC_NO_CHECK_TAR	| \
66 /*	MAGIC_NO_CHECK_SOFT	| */ \
67 	MAGIC_NO_CHECK_APPTYPE	| \
68 	MAGIC_NO_CHECK_ELF	| \
69 	MAGIC_NO_CHECK_TEXT	| \
70 	MAGIC_NO_CHECK_CDF	| \
71 	MAGIC_NO_CHECK_TOKENS	| \
72 	MAGIC_NO_CHECK_ENCODING	| \
73 	0			  \
74 )
75 
76 /* Defined for backwards compatibility (renamed) */
77 #define	MAGIC_NO_CHECK_ASCII	MAGIC_NO_CHECK_TEXT
78 
79 /* Defined for backwards compatibility; do nothing */
80 #define	MAGIC_NO_CHECK_FORTRAN	0x000000 /* Don't check ascii/fortran */
81 #define	MAGIC_NO_CHECK_TROFF	0x000000 /* Don't check ascii/troff */
82 
83 #define MAGIC_VERSION		531	/* This implementation */
84 
85 
86 #ifdef __cplusplus
87 extern "C" {
88 #endif
89 
90 typedef struct magic_set *magic_t;
91 magic_t magic_open(int);
92 void magic_close(magic_t);
93 
94 const char *magic_getpath(const char *, int);
95 const char *magic_file(magic_t, const char *);
96 const char *magic_stream(magic_t, php_stream *);
97 const char *magic_descriptor(magic_t, int);
98 const char *magic_buffer(magic_t, const void *, size_t);
99 
100 const char *magic_error(magic_t);
101 int magic_setflags(magic_t, int);
102 
103 int magic_version(void);
104 int magic_load(magic_t, const char *);
105 int magic_load_buffers(magic_t, void **, size_t *, size_t);
106 
107 int magic_compile(magic_t, const char *);
108 int magic_list(magic_t, const char *);
109 int magic_errno(magic_t);
110 
111 #define MAGIC_PARAM_INDIR_MAX		0
112 #define MAGIC_PARAM_NAME_MAX		1
113 #define MAGIC_PARAM_ELF_PHNUM_MAX	2
114 #define MAGIC_PARAM_ELF_SHNUM_MAX	3
115 #define MAGIC_PARAM_ELF_NOTES_MAX	4
116 #define MAGIC_PARAM_REGEX_MAX		5
117 #define	MAGIC_PARAM_BYTES_MAX		6
118 
119 int magic_setparam(magic_t, int, const void *);
120 int magic_getparam(magic_t, int, void *);
121 
122 #ifdef __cplusplus
123 };
124 #endif
125 
126 #endif /* _MAGIC_H */
127