Skip to content

Location

elva.widgets.ytextarea.location

Location manipulation.

Functions:

  • update_location –

    Move a given location with respect to deletion and insertion ranges of an edit.

update_location(location, delete, insert, target)

Move a given location with respect to deletion and insertion ranges of an edit.

Parameters:

  • location (tuple) –

    tuple before the edit.

  • delete (Selection) –

    range which is deleted during the edit.

  • insert (Selection) –

    range which is inserted during the edit.

  • target (tuple) –

    returned location when location is within the deletion range, typically the start or the end of the insertion range.

Returns:

  • tuple –

    location after the edit.

Source code in src/elva/widgets/ytextarea/location.py 
 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
def update_location(
    location: tuple, delete: Selection, insert: Selection, target: tuple
) -> tuple:
    """
    Move a given location with respect to deletion and insertion ranges of an edit.

    Arguments:
        location: tuple before the edit.
        delete: range which is deleted during the edit.
        insert: range which is inserted during the edit.
        target:
            returned location when `location` is within the deletion range,
            typically the start or the end of the insertion range.

    Returns:
        location after the edit.
    """
    # abbreviate for easier reading
    loc_ = location
    del_ = delete
    ins_ = insert

    if loc_ < del_:
        # `loc_` is not affected by the edit and thus does not change
        pass
    elif loc_ in del_:
        # `loc_` is within the deletion range and set to the `target`
        loc_ = target
    elif loc_ > del_:
        # `loc_` is shifted by the difference in length
        # between delete and insert operations
        shift = (ins_.end[0] - del_.end[0], ins_.end[1] - del_.end[1])

        # only shift columns when edit happened before the row `loc_` is also in
        if del_.end[0] < loc_[0]:
            shift = (shift[0], 0)

        loc_ = (loc_[0] + shift[0], loc_[1] + shift[1])

    return loc_