Pack.Core.Ipkg

Utilities for parsing .ipkg files. Most of this stuff
should actually be available from the Idris API after
some small refactoring.

Definitions

parseIpkgFile : HasIO io => File Abs -> File Abs -> EitherT PackErr io (Desc U)

Visibility: export

sourcePath : Desc t -> Path Abs

  Extract the absolute path to the source directory
  from a package description plus its file location.

Totality: total
Visibility: export

buildPath : Desc t -> Path Abs

  Extract the absolute path to the build directory
  from a package description plus its file location.

Totality: total
Visibility: export

exec : Desc t -> Maybe Body

  Extract the (optional) name of the executable from the
  description of an Idris app.

Totality: total
Visibility: export

execPath : Desc t -> Maybe (File Abs)

  Extract the absolute path to an application's
  executable in the build directory.

Totality: total
Visibility: export

record DocSources : Type

  Path to different files relevant during generation of API docs
  of a single Idris source file (field `srcFile`).

Totality: total
Visibility: public export
Constructor: 

MkDS : File Abs -> File Abs -> File Abs -> File Abs -> DocSources

Projections:

.htmlDoc : DocSources -> File Abs

.srcFile : DocSources -> File Abs

.srcHtml : DocSources -> File Abs

.ttmFile : DocSources -> File Abs

.htmlDoc : DocSources -> File Abs

Totality: total
Visibility: public export

htmlDoc : DocSources -> File Abs

Totality: total
Visibility: public export

.srcFile : DocSources -> File Abs

Totality: total
Visibility: public export

srcFile : DocSources -> File Abs

Totality: total
Visibility: public export

.ttmFile : DocSources -> File Abs

Totality: total
Visibility: public export

ttmFile : DocSources -> File Abs

Totality: total
Visibility: public export

.srcHtml : DocSources -> File Abs

Totality: total
Visibility: public export

srcHtml : DocSources -> File Abs

Totality: total
Visibility: public export

srcExists : HasIO io => DocSources -> EitherT PackErr io Bool

Totality: total
Visibility: export

sourceForDoc : TTCVersion => Desc t -> File Abs -> Maybe DocSources

  Generates the doc paths based on the package description
  (which might use custom source and build directories).

Totality: total
Visibility: export

insertSources : HasIO io => DocSources -> EitherT PackErr io ()

  Insert a link to the katla-generated and highlighted
  sources to the API docs.

Visibility: export