package lambda-term

  1. Overview
  2. Docs
Terminal manipulation library for OCaml

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (12)

Authors

  1. J
    Jérémie Dimino

Maintainers

  1. J
    jeremie@dimino.org

Sources

lambda-term-2.0.tbz
sha256=3f17ccce3d214a6de868bf21f00cd66f15fd3a9a575942d93a2d614f4b9456e8
md5=9284c51c2ef18ebf6c17281879f2ff13

doc/lambda-term/LTerm_resources/index.html

Module LTerm_resourcesSource

Widgets resources

Sourcetype t

Type of resources.

Sourceval empty : t

The empty set of resources.

Sourceval get : string -> t -> string

get key resources returns the key associated to the last pattern that matches key in resources, or the empty string if no pattern matches key.

Sourceval add : string -> string -> t -> t

add pattern value returns the new set of resources with the binding pattern -> value at the end.

Sourceval merge : t -> t -> t

merge res1 res2 merges the two given sets of resources.

Sourceexception Error of string

Exception raised when the contents of a resource is invalid.

Sourceval get_bool : string -> t -> bool option

get_bool name resources reads the boolean encoded in resources.

Sourceval get_color : string -> t -> LTerm_style.color option

get_color name resources reads the color encoded in resources.

Sourceval get_style : string -> t -> LTerm_style.t

get_style prefix resources reads the style encoded in resources.

Sourceval get_connection : string -> t -> LTerm_draw.connection

get_connection name resources

Sourceexception Parse_error of string * int * string

Parse_error(source, line, msg) is raised when a parsing error is encountered in the input.

Sourceval parse : string -> t

parse str parses a string for a list of properties. str must follow the format of X resources files. i.e. comments start with a !, empty lines are ignored, and configuration lines looks-like:

  key: value
Sourceval load : string -> t Lwt.t

Same as parse but parses the contents of a file.

Sourceval home : string

The home directory.

Sourcetype xdg_location =
  1. | Cache
  2. | Config
  3. | Data
    (*

    The type for user-specific 'cached', 'configuration' and 'data' files.

    *)
Sourceval xdgbd_file : loc:xdg_location -> ?allow_legacy_location:bool -> string -> string

xdgbd_file ~loc fn returns the full file-name for a file fn in the XDG Base Directory corresponding to the variant given by loc.

E.g. xdgbd_file ~loc:LTerm_resources.Cache app_history would return something like "/home/user/.cache/app_history"

Follows the XDG Base Directory specification: http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html

The optional parameter allow_legacy_location, default false, first searches if there is already a file with the desired name in the user's home directory. If it finds such a file, it returns that filename, else it resorts to regular behavior.