package cascade

  1. Overview
  2. Docs
package cascade
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Cascade.Font_faceSource

Font-face descriptor types for type-safe \@font-face construction.

Metric Override Types

Sourcetype metric_override =
  1. | Normal
  2. | Percent of float
  3. | Var of metric_override Values.var

Metric override value - either "normal", a percentage, or an unresolved var(). Used for ascent-override, descent-override, line-gap-override.

Sourceval pp_metric_override : metric_override Pp.t

pp_metric_override renders a metric override.

Sourceval string_of_metric_override : metric_override -> string

string_of_metric_override m converts a metric override to its CSS string representation.

Size Adjust

Sourcetype size_adjust =
  1. | Pct of float
  2. | Var of size_adjust Values.var

CSS Fonts 5 sec. 4.4: a <percentage [0,inf]> glyph size multiplier. No descriptor grammar takes a var() (CSS Fonts 4 sec. 4.1), so Var parks a reference until the inline pass substitutes it.

Sourceval pp_size_adjust : size_adjust Pp.t

pp_size_adjust renders one size-adjust value.

Sourceval string_of_size_adjust : size_adjust -> string

string_of_size_adjust s converts size adjust to string.

Font Source

Sourcetype src_entry =
  1. | Url of {
    1. url : string;
    2. format : string option;
    3. tech : string option;
    }
  2. | Quoted_url of {
    1. url : string;
    2. quote : char;
    3. format : string option;
    4. tech : string option;
    }
  3. | Local of string
  4. | Var of src Values.var

A single font source entry.

Sourceand src = src_entry list

Font source list.

Sourcetype t = src

Font source list.

Sourceval equal_metric_override : metric_override -> metric_override -> bool

equal_metric_override a b tests metric overrides for equality.

Sourceval equal_size_adjust : size_adjust -> size_adjust -> bool

equal_size_adjust a b tests size adjustments for equality.

Sourceval compare_size_adjust : size_adjust -> size_adjust -> int

compare_size_adjust a b orders size adjustments.

Sourceval equal_src : src -> src -> bool

equal_src a b tests font source lists for structural equality.

Sourceval pp : t Pp.t

pp renders a font source list.

Sourceval string_of_src_entry : src_entry -> string

string_of_src_entry e converts source entry to string.

Sourceval string_of_src : ?minify:bool -> src -> string

string_of_src entries converts a font source list to its CSS string representation.

Sourceval to_string : ?minify:bool -> t -> string

to_string src converts a font source list to CSS source text.

Parsing

Sourceval read_metric_override : Cursor.t -> metric_override

read_metric_override t reads one ascent-override / descent-override / line-gap-override value, or a var() standing for one. A mismatch raises Cursor.Parse_error without consuming, so the error carries the offending value's span.

Sourceval read_size_adjust : Cursor.t -> size_adjust

read_size_adjust t reads one size-adjust value, like read_metric_override.

Sourceval metric_override_of_string : string -> metric_override

metric_override_of_string s parses a metric override value.

Sourceval size_adjust_of_string : string -> size_adjust

size_adjust_of_string s parses a size-adjust percentage.

Sourceval src_of_string : string -> src

src_of_string s parses a src value. Raises Cursor.Parse_error for unparsed sources.

Sourceval read_src : Cursor.t -> src

read_src t parses a font source list from a component cursor.