contrib/file/src/magic.h

   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              0x000000 /* No flags */
  33 #define MAGIC_DEBUG             0x000001 /* Turn on debugging */
  34 #define MAGIC_SYMLINK           0x000002 /* Follow symlinks */
  35 #define MAGIC_COMPRESS          0x000004 /* Check inside compressed files */
  36 #define MAGIC_DEVICES           0x000008 /* Look at the contents of devices */
  37 #define MAGIC_MIME_TYPE         0x000010 /* Return the MIME type */
  38 #define MAGIC_CONTINUE          0x000020 /* Return all matches */
  39 #define MAGIC_CHECK             0x000040 /* Print warnings to stderr */
  40 #define MAGIC_PRESERVE_ATIME    0x000080 /* Restore access time on exit */
  41 #define MAGIC_RAW               0x000100 /* Don't translate unprintable chars */
  42 #define MAGIC_ERROR             0x000200 /* Handle ENOENT etc as real errors */
  43 #define MAGIC_MIME_ENCODING     0x000400 /* Return the MIME encoding */
  44 #define MAGIC_MIME              (MAGIC_MIME_TYPE|MAGIC_MIME_ENCODING)
  45 #define MAGIC_APPLE             0x000800 /* Return the Apple creator and type */
  46
  47 #define MAGIC_NO_CHECK_COMPRESS 0x001000 /* Don't check for compressed files */
  48 #define MAGIC_NO_CHECK_TAR      0x002000 /* Don't check for tar files */
  49 #define MAGIC_NO_CHECK_SOFT     0x004000 /* Don't check magic entries */
  50 #define MAGIC_NO_CHECK_APPTYPE  0x008000 /* Don't check application type */
  51 #define MAGIC_NO_CHECK_ELF      0x010000 /* Don't check for elf details */
  52 #define MAGIC_NO_CHECK_TEXT     0x020000 /* Don't check for text files */
  53 #define MAGIC_NO_CHECK_CDF      0x040000 /* Don't check for cdf files */
  54 #define MAGIC_NO_CHECK_TOKENS   0x100000 /* Don't check tokens */
  55 #define MAGIC_NO_CHECK_ENCODING 0x200000 /* Don't check text encodings */
  56
  57 /* No built-in tests; only consult the magic file */
  58 #define MAGIC_NO_CHECK_BUILTIN  ( \
  59         MAGIC_NO_CHECK_COMPRESS | \
  60         MAGIC_NO_CHECK_TAR      | \
  61 /*      MAGIC_NO_CHECK_SOFT     | */ \
  62         MAGIC_NO_CHECK_APPTYPE  | \
  63         MAGIC_NO_CHECK_ELF      | \
  64         MAGIC_NO_CHECK_TEXT     | \
  65         MAGIC_NO_CHECK_CDF      | \
  66         MAGIC_NO_CHECK_TOKENS   | \
  67         MAGIC_NO_CHECK_ENCODING | \
  68         0                         \
  69 )
  70
  71 /* Defined for backwards compatibility (renamed) */
  72 #define MAGIC_NO_CHECK_ASCII    MAGIC_NO_CHECK_TEXT
  73
  74 /* Defined for backwards compatibility; do nothing */
  75 #define MAGIC_NO_CHECK_FORTRAN  0x000000 /* Don't check ascii/fortran */
  76 #define MAGIC_NO_CHECK_TROFF    0x000000 /* Don't check ascii/troff */
  77
  78 #define MAGIC_VERSION           521     /* This implementation */
  79
  80
  81 #ifdef __cplusplus
  82 extern "C" {
  83 #endif
  84
  85 typedef struct magic_set *magic_t;
  86 magic_t magic_open(int);
  87 void magic_close(magic_t);
  88
  89 const char *magic_getpath(const char *, int);
  90 const char *magic_file(magic_t, const char *);
  91 const char *magic_descriptor(magic_t, int);
  92 const char *magic_buffer(magic_t, const void *, size_t);
  93
  94 const char *magic_error(magic_t);
  95 int magic_setflags(magic_t, int);
  96
  97 int magic_version(void);
  98 int magic_load(magic_t, const char *);
  99 int magic_load_buffers(magic_t, void **, size_t *, size_t);
 100
 101 int magic_compile(magic_t, const char *);
 102 int magic_check(magic_t, const char *);
 103 int magic_list(magic_t, const char *);
 104 int magic_errno(magic_t);
 105
 106 #define MAGIC_PARAM_INDIR_MAX           0
 107 #define MAGIC_PARAM_NAME_MAX            1
 108 #define MAGIC_PARAM_ELF_PHNUM_MAX       2
 109 #define MAGIC_PARAM_ELF_SHNUM_MAX       3
 110 #define MAGIC_PARAM_ELF_NOTES_MAX       4
 111
 112 int magic_setparam(magic_t, int, const void *);
 113 int magic_getparam(magic_t, int, void *);
 114
 115 #ifdef __cplusplus
 116 };
 117 #endif
 118
 119 #endif /* _MAGIC_H */