xref: /openbsd-src/usr.bin/file/magic.h (revision daf88648c0e349d5c02e1504293082072c981640)
1 /* $OpenBSD: magic.h,v 1.2 2004/05/19 02:36:26 tedu 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  * 3. The name of the author may not be used to endorse or promote products
16  *    derived from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
22  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 #ifndef _MAGIC_H
31 #define _MAGIC_H
32 
33 #include <sys/types.h>
34 
35 #define	MAGIC_NONE		0x000	/* No flags */
36 #define	MAGIC_DEBUG		0x001	/* Turn on debugging */
37 #define	MAGIC_SYMLINK		0x002	/* Follow symlinks */
38 #define	MAGIC_COMPRESS		0x004	/* Check inside compressed files */
39 #define	MAGIC_DEVICES		0x008	/* Look at the contents of devices */
40 #define	MAGIC_MIME		0x010	/* Return a mime string */
41 #define	MAGIC_CONTINUE		0x020	/* Return all matches */
42 #define	MAGIC_CHECK		0x040	/* Print warnings to stderr */
43 #define	MAGIC_PRESERVE_ATIME	0x080	/* Restore access time on exit */
44 #define	MAGIC_RAW		0x100	/* Don't translate unprintable chars */
45 #define	MAGIC_ERROR		0x200	/* Handle ENOENT etc as real errors */
46 
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
51 typedef struct magic_set *magic_t;
52 magic_t magic_open(int);
53 void magic_close(magic_t);
54 
55 const char *magic_file(magic_t, const char *);
56 const char *magic_buffer(magic_t, const void *, size_t);
57 
58 const char *magic_error(magic_t);
59 int magic_setflags(magic_t, int);
60 
61 int magic_load(magic_t, const char *);
62 int magic_compile(magic_t, const char *);
63 int magic_check(magic_t, const char *);
64 int magic_errno(magic_t);
65 
66 #ifdef __cplusplus
67 };
68 #endif
69 
70 #endif /* _MAGIC_H */
71