The file-types Reference Manual

Table of Contents

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

The file-types Reference Manual

This is the file-types Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:46:36 2018 GMT+0.


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

1 Introduction

file-types

Description:

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

Documentation:


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

2 Systems

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


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

2.1 file-types

Author

Max Rottenkolber <max@mr.gy>

License

GNU AGPL

Description

Simple scheme to classify file types in a hierarchical fashion.

Source

file-types.asd (file)

Components

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

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 files   [Contents][Index]

3.1.1 file-types.asd

Location

file-types.asd

Systems

file-types (system)

Packages

file-types-asd


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

3.1.2 file-types/package.lisp

Parent

file-types (system)

Location

package.lisp

Packages

file-types


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

3.1.3 file-types/types.lisp

Dependency

package.lisp (file)

Parent

file-types (system)

Location

types.lisp

Internal Definitions

*file-type-list* (special variable)


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

3.1.4 file-types/names.lisp

Dependency

package.lisp (file)

Parent

file-types (system)

Location

names.lisp

Internal Definitions

*file-name-list* (special variable)


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

3.1.5 file-types/access.lisp

Dependencies
Parent

file-types (system)

Location

access.lisp

Exported Definitions
Internal Definitions

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

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

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

4.2 file-types

Simple scheme to classify file types in a hierarchical fashion.

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 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 (file)

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 (file)


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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *file-name-hash*

Special file name to extension map.

Package

file-types

Source

access.lisp (file)

Special Variable: *file-name-list*
Package

file-types

Source

names.lisp (file)

Special Variable: *file-type-hash*

Extension to property map.

Package

file-types

Source

access.lisp (file)

Special Variable: *file-type-list*

List of known file extensions and associated tags.

Package

file-types

Source

types.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: file-name FILE

Return extension for FILE or NIL.

Package

file-types

Source

access.lisp (file)

Function: file-property FILE PROPERTY

Return property of FILE or NIL.

Package

file-types

Source

access.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L  
Index Entry  Section

F
File, Lisp, file-types.asd: The file-types<dot>asd file
File, Lisp, file-types/access.lisp: The file-types/access<dot>lisp file
File, Lisp, file-types/names.lisp: The file-types/names<dot>lisp file
File, Lisp, file-types/package.lisp: The file-types/package<dot>lisp file
File, Lisp, file-types/types.lisp: The file-types/types<dot>lisp file
file-types.asd: The file-types<dot>asd file
file-types/access.lisp: The file-types/access<dot>lisp file
file-types/names.lisp: The file-types/names<dot>lisp file
file-types/package.lisp: The file-types/package<dot>lisp file
file-types/types.lisp: The file-types/types<dot>lisp file

L
Lisp File, file-types.asd: The file-types<dot>asd file
Lisp File, file-types/access.lisp: The file-types/access<dot>lisp file
Lisp File, file-types/names.lisp: The file-types/names<dot>lisp file
Lisp File, file-types/package.lisp: The file-types/package<dot>lisp file
Lisp File, file-types/types.lisp: The file-types/types<dot>lisp file

Jump to:   F   L  

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

A.2 Functions

Jump to:   F  
Index Entry  Section

F
file-mime: Exported functions
file-name: Internal functions
file-property: Internal functions
file-tags: Exported functions
Function, file-mime: Exported functions
Function, file-name: Internal functions
Function, file-property: Internal functions
Function, file-tags: Exported functions

Jump to:   F  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*file-name-hash*: Internal special variables
*file-name-list*: Internal special variables
*file-type-hash*: Internal special variables
*file-type-list*: Internal special variables

S
Special Variable, *file-name-hash*: Internal special variables
Special Variable, *file-name-list*: Internal special variables
Special Variable, *file-type-hash*: Internal special variables
Special Variable, *file-type-list*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   F   P   S  
Index Entry  Section

F
file-types: The file-types system
file-types: The file-types package
file-types-asd: The file-types-asd package

P
Package, file-types: The file-types package
Package, file-types-asd: The file-types-asd package

S
System, file-types: The file-types system

Jump to:   F   P   S