The fs-watcher Reference Manual

Table of Contents

The fs-watcher Reference Manual

This is the fs-watcher Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 11:06:26 2020 GMT+0.

1 Introduction

fs-watcher

Description

Watches for filesystem changes to act upon them.

Documentation

There is not much to this library. Only a single function.

Installation

(ql:quickload 'fs-watcher)

The watch function

This is the signature of the function:

(fs-watcher:watch pathnames callback &key (delay 1))

• pathnames is a pathname or a list of pathnames. Both are accepted.
• callback is a callback function called on each change.
• :delay is the looping delay.

At first, the function will get the list of all pathnames. For example, if you give a directory pathname, fs-watcher will recursively look for files and directories in it.

Once it has all the necessary information, it constantly polls for them to see if there is any change. This polling is done every second by default.

Whenever there is a change, the callback is called with an argument: the pathname that changed.

Usage example

(fs-watcher:watch "/home/user/code/" #'(lambda (pathname)
                                         (inferior-shell:run/s "make")))

Contributors

• Florian Margaine

License

MIT License.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 fs-watcher

Author

Florian Margaine <florian@margaine.com>

License

MIT License

Description

Filesystem watcher for changes

Dependencies

• com.gigamonkeys.pathnames
• alexandria

Source

fs-watcher.asd (file)

Components

• src/package.lisp (file)
• src/fs-watcher.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 fs-watcher.asd

Location

fs-watcher.asd

Systems

fs-watcher (system)

3.1.2 fs-watcher/src/package.lisp

Parent

fs-watcher (system)

Location

src/package.lisp

Packages

fs-watcher

3.1.3 fs-watcher/src/fs-watcher.lisp

Dependency

src/package.lisp (file)

Parent

fs-watcher (system)

Location

src/fs-watcher.lisp

Exported Definitions

watch (function)

Internal Definitions

• dir-contents (function)
• mtime (function)
• run-loop (function)

4 Packages

Packages are listed by definition order.

4.1 fs-watcher

Source

src/package.lisp (file)

Use List

• com.gigamonkeys.pathnames
• common-lisp

Exported Definitions

watch (function)

Internal Definitions

• dir-contents (function)
• mtime (function)
• run-loop (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: watch PATHNAMES CALLBACK &key DELAY

Watches a list of pathnames

Package

fs-watcher

Source

src/fs-watcher.lisp (file)

5.2 Internal definitions

5.2.1 Functions

Function: dir-contents PATHNAMES

For each directory, collect the file pathnames recursively. Results are appended and returned as a single list.

Package

fs-watcher

Source

src/fs-watcher.lisp (file)

Function: mtime PATHNAME

Returns the mtime of a pathname

Package

fs-watcher

Source

src/fs-watcher.lisp (file)

Function: run-loop PATHNAMES MTIMES CALLBACK DELAY

The main loop constantly polling the filesystem

Package

fs-watcher

Source

src/fs-watcher.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types