file/src/magic.h

Go to the documentation of this file.

/*
 * Copyright (c) Christos Zoulas 2003.
 * All Rights Reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice immediately at the beginning of the file, without modification,
 *    this list of conditions, and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *  
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */
#ifndef _MAGIC_H
#define _MAGIC_H

#include <sys/types.h>

#define MAGIC_NONE              0x000000 /* No flags */
#define MAGIC_DEBUG             0x000001 /* Turn on debugging */
#define MAGIC_SYMLINK           0x000002 /* Follow symlinks */
#define MAGIC_COMPRESS          0x000004 /* Check inside compressed files */
#define MAGIC_DEVICES           0x000008 /* Look at the contents of devices */
#define MAGIC_MIME              0x000010 /* Return a mime string */
#define MAGIC_CONTINUE          0x000020 /* Return all matches */
#define MAGIC_CHECK             0x000040 /* Print warnings to stderr */
#define MAGIC_PRESERVE_ATIME    0x000080 /* Restore access time on exit */
#define MAGIC_RAW               0x000100 /* Don't translate unprintable chars */
#define MAGIC_ERROR             0x000200 /* Handle ENOENT etc as real errors */
#define MAGIC_NO_CHECK_COMPRESS 0x001000 /* Don't check for compressed files */
#define MAGIC_NO_CHECK_TAR      0x002000 /* Don't check for tar files */
#define MAGIC_NO_CHECK_SOFT     0x004000 /* Don't check magic entries */
#define MAGIC_NO_CHECK_APPTYPE  0x008000 /* Don't check application type */
#define MAGIC_NO_CHECK_ELF      0x010000 /* Don't check for elf details */
#define MAGIC_NO_CHECK_ASCII    0x020000 /* Don't check for ascii files */
#define MAGIC_NO_CHECK_TROFF    0x040000 /* Don't check ascii/troff */
#define MAGIC_NO_CHECK_FORTRAN  0x080000 /* Don't check ascii/fortran */
#define MAGIC_NO_CHECK_TOKENS   0x100000 /* Don't check ascii/tokens */

#ifdef __cplusplus
extern "C" {
#endif

typedef struct magic_set *magic_t;
/*@null@*/
magic_t magic_open(int)
        /*@globals errno @*/
        /*@modifies errno @*/;
void magic_close(magic_t ms)
        /*@globals fileSystem @*/
        /*@modifies ms, fileSystem @*/;

/*@observer@*/ /*@null@*/
const char *magic_file(magic_t ms, /*@null@*/ const char * inname)
        /*@globals errno, fileSystem, internalState @*/
        /*@modifies ms, errno, fileSystem, internalState @*/;
/*@observer@*/ /*@null@*/
const char *magic_buffer(magic_t ms, const void *, size_t)
        /*@globals fileSystem, internalState @*/
        /*@modifies ms, fileSystem, internalState @*/;

/*@observer@*/
const char *magic_error(magic_t ms)
        /*@modifies ms @*/;
int magic_setflags(magic_t ms, int)
        /*@modifies ms @*/;

int magic_load(magic_t ms, const char *)
        /*@globals fileSystem, internalState @*/
        /*@modifies ms, fileSystem, internalState @*/;
int magic_compile(magic_t ms, const char *)
        /*@globals fileSystem, internalState @*/
        /*@modifies ms, fileSystem, internalState @*/;
int magic_check(magic_t ms, const char *)
        /*@globals fileSystem, internalState @*/
        /*@modifies ms, fileSystem, internalState @*/;
int magic_errno(magic_t ms)
        /*@modifies ms @*/;

#ifdef __cplusplus
};
#endif

#endif /* _MAGIC_H */

---