xref: /openbsd-src/usr.bin/file/magic.h (revision a28daedfc357b214be5c701aa8ba8adb29a7f1c2)
1 /* $OpenBSD: magic.h,v 1.4 2009/04/24 18:54:34 chl Exp $ */
2 /*
3  * Copyright (c) Christos Zoulas 2003.
4  * All Rights Reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice immediately at the beginning of the file, without modification,
11  *    this list of conditions, and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 #ifndef _MAGIC_H
29 #define _MAGIC_H
30 
31 #include <sys/types.h>
32 
33 #define	MAGIC_NONE		0x000000 /* No flags */
34 #define	MAGIC_DEBUG		0x000001 /* Turn on debugging */
35 #define	MAGIC_SYMLINK		0x000002 /* Follow symlinks */
36 #define	MAGIC_COMPRESS		0x000004 /* Check inside compressed files */
37 #define	MAGIC_DEVICES		0x000008 /* Look at the contents of devices */
38 #define	MAGIC_MIME_TYPE		0x000010 /* Return only the MIME type */
39 #define	MAGIC_CONTINUE		0x000020 /* Return all matches */
40 #define	MAGIC_CHECK		0x000040 /* Print warnings to stderr */
41 #define	MAGIC_PRESERVE_ATIME	0x000080 /* Restore access time on exit */
42 #define	MAGIC_RAW		0x000100 /* Don't translate unprint chars */
43 #define	MAGIC_ERROR		0x000200 /* Handle ENOENT etc as real errors */
44 #define	MAGIC_MIME_ENCODING	0x000400 /* Return only the MIME encoding */
45 #define MAGIC_MIME		(MAGIC_MIME_TYPE|MAGIC_MIME_ENCODING)
46 #define	MAGIC_NO_CHECK_COMPRESS	0x001000 /* Don't check for compressed files */
47 #define	MAGIC_NO_CHECK_TAR	0x002000 /* Don't check for tar files */
48 #define	MAGIC_NO_CHECK_SOFT	0x004000 /* Don't check magic entries */
49 #define	MAGIC_NO_CHECK_APPTYPE	0x008000 /* Don't check application type */
50 #define	MAGIC_NO_CHECK_ELF	0x010000 /* Don't check for elf details */
51 #define	MAGIC_NO_CHECK_ASCII	0x020000 /* Don't check for ascii files */
52 #define	MAGIC_NO_CHECK_TOKENS	0x100000 /* Don't check ascii/tokens */
53 
54 /* Defined for backwards compatibility; do nothing */
55 #define	MAGIC_NO_CHECK_FORTRAN	0x000000 /* Don't check ascii/fortran */
56 #define	MAGIC_NO_CHECK_TROFF	0x000000 /* Don't check ascii/troff */
57 
58 
59 #ifdef __cplusplus
60 extern "C" {
61 #endif
62 
63 typedef struct magic_set *magic_t;
64 magic_t magic_open(int);
65 void magic_close(magic_t);
66 
67 const char *magic_file(magic_t, const char *);
68 const char *magic_descriptor(magic_t, int);
69 const char *magic_buffer(magic_t, const void *, size_t);
70 
71 const char *magic_error(magic_t);
72 int magic_setflags(magic_t, int);
73 
74 int magic_load(magic_t, const char *);
75 int magic_compile(magic_t, const char *);
76 int magic_check(magic_t, const char *);
77 int magic_errno(magic_t);
78 
79 #ifdef __cplusplus
80 };
81 #endif
82 
83 #endif /* _MAGIC_H */
84