package.lisp

   1 ;;; -*- mode: lisp; syntax: common-lisp; coding: utf-8; package: cl-user; -*-
   2
   3 ;; Copyright (c) 2011, Olof-Joachim Frahm
   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 are met:
   8 ;;     * Redistributions of source code must retain the above copyright
   9 ;;       notice, this list of conditions and the following disclaimer.
  10 ;;     * Redistributions in binary form must reproduce the above copyright
  11 ;;       notice, this list of conditions and the following disclaimer in the
  12 ;;       documentation and/or other materials provided with the distribution.
  13 ;;     * The name of the author may not be used to endorse or promote products
  14 ;;       derived from this software without specific prior written permission.
  15
  16 ;; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17 ;; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 ;; IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 ;; ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
  20 ;; DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21 ;; (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22 ;; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23 ;; ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 ;; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 ;; THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26
  27 (in-package #:cl-user)
  28
  29 (defpackage cl-inotify
  30   (:use #:cl #:cffi)
  31   (:export ;;; used types for documentation
  32            #:inotify-add/read-flag
  33            #:inotify-read-flag
  34            #:inotify-add-flag
  35
  36            ;;; very raw
  37            #:read-raw-event-from-stream
  38
  39            #:close-inotify
  40
  41            ;;; event parsing functions
  42            #:make-unregistered-inotify
  43            #:read-event-from-stream
  44            #:watch-raw
  45            #:unwatch-raw
  46
  47            ;;; enhanced functionality
  48            #:make-inotify
  49            #:watchedp
  50            #:watch
  51            #:unwatch
  52            #:event-availablep
  53            #:read-event
  54            #:next-event
  55
  56            ;;; convenience functions
  57            #:list-watched
  58            #:do-events
  59            #:next-events)
  60   (:documentation "A binding (not only?) for the LINUX inotify(7) API."))