magicffi

2021-05-31

cffi interface to libmagic(3)

Upstream URL

github.com/guicho271828/magicffi

Author

Desmond O. Chang <dochang+magicffi@gmail.com>

Maintainer

Desmond O. Chang <dochang+magicffi@gmail.com>

License

Simplified BSD License
README

MAGICFFI Build Status

MAGICFFI is a CFFI interface to libmagic(3), the file type determination library using ``magic'' numbers.

Download

To check out the git repository, run:

$ git clone git://github.com/guicho271828/magicffi.git

Installation

MAGICFFI depends on the following lisp libraries:

  • CFFI
  • CL-PPCRE (used by the internal flags generator)

The following system packages are also required:

  • libmagic-dev
  • libc6-dev
  • gcc

You have to install them on your system before loading magicffi.

Tutorial

> (asdf:load-system :magicffi)
> (use-package :magicffi)
> (with-open-magic (magic '(:mime-type :symlink))
    (magic-file magic #P"magicffi.asd"))
"text/plain"

Documentation

All external symbols of the package MAGICFFI are listed in package.lisp. Check out their docstrings for help.

Magic Flags

You can use either constants or keyword list as magic flags. I.e.,

(magic-open (logxor +magic-mime-type+ +magic-symlink+))

is equivalent to

(magic-open '(:mime-type :symlink))

The constant name and keyword name of a flag are based on its C name. See the following table for the pattern:

C nameLisp constantLisp keyword
MAGIC_NONE+MAGIC-NONE+:NONE

All constant names are exported.

Credit

  • Desmond O. Chang (original author)
  • Peter Hillerström
  • Pocket7878
  • Masataro Asai

Dependencies (3)

  • cffi
  • cl-ppcre
  • fiveam

Dependents (2)

  • GitHub
  • Quicklisp