UNPKG

wed

Version:

Wed is a schema-aware editor for XML documents.

github.com/mangalam-research/wed

mangalam-research/wed

67 lines (66 loc) • 2.84 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/** * Library of caret movement computations. * @author Louis-Dominique Dubeau * @license MPL 2.0 * @copyright Mangalam Research Center for Buddhist Languages */ import { DLoc } from "./dloc"; import { ModeTree } from "./mode-tree"; export declare type Direction = "right" | "left" | "up" | "down"; export declare function newPosition(pos: DLoc | undefined | null, direction: Direction, docRoot: Document | Element, modeTree: ModeTree): DLoc | undefined; /** * Compute the position to the right of a starting position. This function takes * into account wed-specific needs. For instance, it knows how start and end * labels are structured. * * @param pos The position at which we start. * * @param docRoot The element within which caret movement is to be constrained. * * @param modeTree The mode tree from which to get a mode. * * @returns The new position, or ``undefined`` if there is no such position. */ export declare function positionRight(pos: DLoc | undefined | null, docRoot: Document | Element, modeTree: ModeTree): DLoc | undefined; /** * Compute the position to the left of a starting position. This function takes * into account wed-specific needs. For instance, it knows how start and end * labels are structured. * * @param pos The position at which we start. * * @param docRoot The element within which caret movement is to be constrained. * * @param modeTree The mode tree from which to get a mode. * * @returns The new position, or ``undefined`` if there is no such position. */ export declare function positionLeft(pos: DLoc | undefined | null, docRoot: Document | Element, modeTree: ModeTree): DLoc | undefined; /** * Compute the position under a starting position. This function takes into * account wed-specific needs. For instance, it knows how start and end labels * are structured. * * @param pos The position at which we start. * * @param docRoot The element within which caret movement is to be constrained. * * @param modeTree The mode tree from which to get a mode. * * @returns The new position, or ``undefined`` if there is no such position. */ export declare function positionDown(pos: DLoc | undefined | null, docRoot: Document | Element, modeTree: ModeTree): DLoc | undefined; /** * Compute the position above a starting position. This function takes into * account wed-specific needs. For instance, it knows how start and end labels * are structured. * * @param pos The position at which we start. * * @param docRoot The element within which caret movement is to be constrained. * * @param modeTree The mode tree from which to get a mode. * * @returns The new position, or ``undefined`` if there is no such position. */ export declare function positionUp(pos: DLoc | undefined | null, docRoot: Document | Element, modeTree: ModeTree): DLoc | undefined;