The file-types Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The file-types Reference Manual

This is the file-types Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:33:11 2022 GMT+0.

Table of Contents


1 Introduction

file-types

Description:

Simple scheme to classify file types in a hierarchical fashion. Includes support for associating and querying MIME types.

Documentation:


2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 file-types

Simple scheme to classify file types in a hierarchical fashion.

Author

Max Rottenkolber <max@mr.gy>

License

GNU AGPL

Source

file-types.asd.

Child Components

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.1 file-types/file-types.asd

Source

file-types.asd.

Parent Component

file-types (system).

ASDF Systems

file-types.

Packages

file-types-asd.


3.1.2 file-types/package.lisp

Source

file-types.asd.

Parent Component

file-types (system).

Packages

file-types.


3.1.3 file-types/types.lisp

Dependency

package.lisp (file).

Source

file-types.asd.

Parent Component

file-types (system).

Internals

*file-type-list* (special variable).


3.1.4 file-types/names.lisp

Dependency

package.lisp (file).

Source

file-types.asd.

Parent Component

file-types (system).

Internals

*file-name-list* (special variable).


Previous: , Up: Lisp   [Contents][Index]

3.1.5 file-types/access.lisp

Dependencies
Source

file-types.asd.

Parent Component

file-types (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 file-types-asd

Source

file-types.asd.

Use List
  • asdf/interface.
  • common-lisp.

Previous: , Up: Packages   [Contents][Index]

4.2 file-types

Simple scheme to classify file types in a hierarchical fashion.

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface


5.1.1 Ordinary functions

Function: file-mime (file)

→ _mime-type_

*Arguments and Values:*

_file_—a _pathname designator_.

_mime-type_—a two-element _list_ containing both MIME type parts as _strings_ or {nil}.

*Description:*

{file-mime} returns the _mime-type_ of _file_ or {nil} if one could not be determined.

Package

file-types.

Source

access.lisp.

Function: file-tags (file &optional tag)

→ _tags_

*Arguments and Values:*

_file_—a _pathname designator_.

_tag_—a _keyword_.

_tags_—a _list_ of _keywords_ which describe properties of a given _file_.

*Description:*

{file-tags} returns _tags_ for _file_. If _tag_ is given, {file-tags} acts as a predicate that tests if _tag_ is associated with _file_. In that case {file-tags} will return {nil} unless _tag_ would be present in _tags_.

Package

file-types.

Source

access.lisp.


5.2 Internals


Next: , Previous: , Up: Internals   [Contents][Index]

5.2.1 Special variables

Special Variable: *file-name-hash*

Special file name to extension map.

Package

file-types.

Source

access.lisp.

Special Variable: *file-name-list*
Package

file-types.

Source

names.lisp.

Special Variable: *file-type-hash*

Extension to property map.

Package

file-types.

Source

access.lisp.

Special Variable: *file-type-list*

List of known file extensions and associated tags.

Package

file-types.

Source

types.lisp.


Previous: , Up: Internals   [Contents][Index]

5.2.2 Ordinary functions

Function: file-name (file)

Return extension for FILE or NIL.

Package

file-types.

Source

access.lisp.

Function: file-property (file property)

Return property of FILE or NIL.

Package

file-types.

Source

access.lisp.


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts