ProsemirrorEx.Transform.Mapping (prosemirror_ex v0.3.0)

Copy Markdown View Source

A mapping represents a pipeline of zero or more StepMaps. It has special provisions for losslessly handling mapping positions through a series of steps in which some steps are inverted versions of earlier steps.

Ports Mapping from prosemirror-transform/src/map.ts.

Summary

Types

t()

Functions

append_map(mapping, map, mirrors \\ nil)

Add a step map to the end of this mapping. If mirrors is given, it should be the index of the step map that is the mirror image of this one.

append_mapping(mapping, other)

Add all the step maps in a given mapping to this one (preserving mirroring information).

append_mapping_inverted(mapping, other)

Append the inverse of the given mapping to this one.

get_mirror(mapping, n)

Finds the offset of the step map that mirrors the map at the given offset.

invert(mapping)

Create an inverted version of this mapping.

map(mapping, pos, assoc \\ 1)

Map a position through this mapping.

map_result(mapping, pos, assoc \\ 1)

Map a position through this mapping, returning a MapResult.

new()

Create a new empty Mapping.

new(maps)

Create a new Mapping with the given maps.

slice(mapping, from \\ 0, to)

Create a mapping that maps only through a part of this one.

Types

t()

@type t() :: %ProsemirrorEx.Transform.Mapping{
  from: non_neg_integer(),
  maps: [ProsemirrorEx.Transform.StepMap.t()],
  mirror: [non_neg_integer()] | nil,
  to: non_neg_integer()
}

Functions

append_map(mapping, map, mirrors \\ nil)

Add a step map to the end of this mapping. If mirrors is given, it should be the index of the step map that is the mirror image of this one.

append_mapping(mapping, other)

Add all the step maps in a given mapping to this one (preserving mirroring information).

append_mapping_inverted(mapping, other)

Append the inverse of the given mapping to this one.

get_mirror(mapping, n)

Finds the offset of the step map that mirrors the map at the given offset.

invert(mapping)

Create an inverted version of this mapping.

map(mapping, pos, assoc \\ 1)

Map a position through this mapping.

map_result(mapping, pos, assoc \\ 1)

Map a position through this mapping, returning a MapResult.

new()

Create a new empty Mapping.

new(maps)

Create a new Mapping with the given maps.

slice(mapping, from \\ 0, to)

Create a mapping that maps only through a part of this one.