xref: /dragonfly/contrib/file/src/magic.h.in (revision 970935fd377c084648da946d7d7e6d0286f5f89a)
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_CSV    0x0080000 /* Don't check for CSV files */
60#define   MAGIC_NO_CHECK_TOKENS         0x0100000 /* Don't check tokens */
61#define MAGIC_NO_CHECK_ENCODING 0x0200000 /* Don't check text encodings */
62#define MAGIC_NO_CHECK_JSON   0x0400000 /* Don't check for JSON files */
63
64/* No built-in tests; only consult the magic file */
65#define MAGIC_NO_CHECK_BUILTIN          ( \
66          MAGIC_NO_CHECK_COMPRESS       | \
67          MAGIC_NO_CHECK_TAR  | \
68/*        MAGIC_NO_CHECK_SOFT | */ \
69          MAGIC_NO_CHECK_APPTYPE        | \
70          MAGIC_NO_CHECK_ELF  | \
71          MAGIC_NO_CHECK_TEXT | \
72          MAGIC_NO_CHECK_CSV  | \
73          MAGIC_NO_CHECK_CDF  | \
74          MAGIC_NO_CHECK_TOKENS         | \
75          MAGIC_NO_CHECK_ENCODING       | \
76          MAGIC_NO_CHECK_JSON | \
77          0                               \
78)
79
80#define MAGIC_SNPRINTB "\177\020\
81b\0debug\0\
82b\1symlink\0\
83b\2compress\0\
84b\3devices\0\
85b\4mime_type\0\
86b\5continue\0\
87b\6check\0\
88b\7preserve_atime\0\
89b\10raw\0\
90b\11error\0\
91b\12mime_encoding\0\
92b\13apple\0\
93b\14no_check_compress\0\
94b\15no_check_tar\0\
95b\16no_check_soft\0\
96b\17no_check_sapptype\0\
97b\20no_check_elf\0\
98b\21no_check_text\0\
99b\22no_check_cdf\0\
100b\23no_check_reserved0\0\
101b\24no_check_tokens\0\
102b\25no_check_encoding\0\
103b\26no_check_json\0\
104b\27no_check_reserved2\0\
105b\30extension\0\
106b\31transp_compression\0\
107"
108
109/* Defined for backwards compatibility (renamed) */
110#define   MAGIC_NO_CHECK_ASCII          MAGIC_NO_CHECK_TEXT
111
112/* Defined for backwards compatibility; do nothing */
113#define   MAGIC_NO_CHECK_FORTRAN        0x000000 /* Don't check ascii/fortran */
114#define   MAGIC_NO_CHECK_TROFF          0x000000 /* Don't check ascii/troff */
115
116#define MAGIC_VERSION                   X.YY      /* This implementation */
117
118
119#ifdef __cplusplus
120extern "C" {
121#endif
122
123typedef struct magic_set *magic_t;
124magic_t magic_open(int);
125void magic_close(magic_t);
126
127const char *magic_getpath(const char *, int);
128const char *magic_file(magic_t, const char *);
129const char *magic_descriptor(magic_t, int);
130const char *magic_buffer(magic_t, const void *, size_t);
131
132const char *magic_error(magic_t);
133int magic_getflags(magic_t);
134int magic_setflags(magic_t, int);
135
136int magic_version(void);
137int magic_load(magic_t, const char *);
138int magic_load_buffers(magic_t, void **, size_t *, size_t);
139
140int magic_compile(magic_t, const char *);
141int magic_check(magic_t, const char *);
142int magic_list(magic_t, const char *);
143int magic_errno(magic_t);
144
145#define MAGIC_PARAM_INDIR_MAX           0
146#define MAGIC_PARAM_NAME_MAX            1
147#define MAGIC_PARAM_ELF_PHNUM_MAX       2
148#define MAGIC_PARAM_ELF_SHNUM_MAX       3
149#define MAGIC_PARAM_ELF_NOTES_MAX       4
150#define MAGIC_PARAM_REGEX_MAX           5
151#define   MAGIC_PARAM_BYTES_MAX                   6
152#define   MAGIC_PARAM_ENCODING_MAX      7
153
154int magic_setparam(magic_t, int, const void *);
155int magic_getparam(magic_t, int, void *);
156
157#ifdef __cplusplus
158};
159#endif
160
161#endif /* _MAGIC_H */
162