All files / roosterjs-content-model-dom/lib/modelApi/editing deleteSegment.ts

100% Statements 60/60
100% Branches 62/62
100% Functions 3/3
100% Lines 57/57

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 1661x 1x 1x 1x 1x                                   1x             163x       163x 163x 163x 163x   163x 161x     163x       23x 23x     7x             7x 6x 6x           7x     127x 88x 88x 39x 37x   37x   37x 35x     37x   37x 11x       127x     4x 3x 3x   1x       2x                   131x   131x   17x   17x       7x       10x   10x   2x       2x     2x       2x     6x     10x                   161x   161x 15x     161x   161x 54x      
import { deleteSingleChar } from './deleteSingleChar';
import { isWhiteSpacePreserved } from '../../domUtils/isWhiteSpacePreserved';
import { mutateSegment } from '../common/mutate';
import { normalizeSingleSegment } from '../common/normalizeSegment';
import { normalizeText } from '../../domUtils/stringUtil';
import type {
    EntityRemovalOperation,
    FormatContentModelContext,
    ReadonlyContentModelParagraph,
    ReadonlyContentModelSegment,
    ShallowMutableContentModelSegment,
} from 'roosterjs-content-model-types';
 
/**
 * Delete a content model segment from current selection
 * @param readonlyParagraph Parent paragraph of the segment to delete
 * @param readonlySegmentToDelete The segment to delete
 * @param context @optional Context object provided by formatContentModel API
 * @param direction @optional Whether this is deleting forward or backward. This is only used for deleting entity.
 * @param undeletableSegments @optional When passed, if this segment is undeletable, it will be added to this array instead of being deleted.
 * If not specified, only selected entity will be deleted
 */
export function deleteSegment(
    readonlyParagraph: ReadonlyContentModelParagraph,
    readonlySegmentToDelete: ReadonlyContentModelSegment,
    context?: FormatContentModelContext,
    direction?: 'forward' | 'backward',
    undeletableSegments?: ShallowMutableContentModelSegment[]
): boolean {
    const [paragraph, segmentToDelete, index] = mutateSegment(
        readonlyParagraph,
        readonlySegmentToDelete
    );
    const segments = paragraph.segments;
    const preserveWhiteSpace = isWhiteSpacePreserved(paragraph.format.whiteSpace);
    const isForward = direction == 'forward';
    const isBackward = direction == 'backward';
 
    if (!preserveWhiteSpace) {
        normalizePreviousSegment(paragraph, segments, index);
    }
 
    switch (segmentToDelete?.segmentType) {
        case 'Br':
        case 'Image':
        case 'SelectionMarker':
            removeSegment(segments, index, direction, undeletableSegments);
            return true;
 
        case 'Entity':
            const operation: EntityRemovalOperation | undefined = segmentToDelete.isSelected
                ? 'overwrite'
                : isForward
                ? 'removeFromStart'
                : isBackward
                ? 'removeFromEnd'
                : undefined;
            if (operation !== undefined) {
                removeSegment(segments, index, direction, undeletableSegments);
                context?.deletedEntities.push({
                    entity: segmentToDelete,
                    operation,
                });
            }
 
            return true;
 
        case 'Text':
            if (segmentToDelete.text.length == 0 || segmentToDelete.isSelected) {
                segmentToDelete.text = '';
                removeSegment(segments, index, direction, undeletableSegments);
            } else if (direction) {
                let text = segmentToDelete.text;
 
                text = deleteSingleChar(text, isForward); //  isForward ? text.substring(1) : text.substring(0, text.length - 1);
 
                if (!preserveWhiteSpace) {
                    text = normalizeText(text, isForward);
                }
 
                segmentToDelete.text = text;
 
                if (text == '') {
                    removeSegment(segments, index, direction, undeletableSegments);
                }
            }
 
            return true;
 
        case 'General':
            if (segmentToDelete.isSelected) {
                removeSegment(segments, index, direction, undeletableSegments);
                return true;
            } else {
                return false;
            }
 
        default:
            return false;
    }
}
 
function removeSegment(
    segments: ShallowMutableContentModelSegment[],
    index: number,
    direction?: 'forward' | 'backward',
    undeletableSegments?: ShallowMutableContentModelSegment[]
) {
    const segment = segments.splice(index, 1)[0];
 
    if (segment.link?.format.undeletable) {
        // Segment is not deletable, but at least we should unselect it
        delete segment.isSelected;
 
        if (undeletableSegments) {
            // For undeletable segments, if an undeletableSegments array is passed in,
            // put it into this array after we delete it, so caller knows that we have deleted some undeletable segments
            // and do proper handling
            undeletableSegments.push(segment);
        } else {
            // Otherwise, we need to reinsert it back to the segments array to keep the model consistent.
            // We need to find the right place to insert it back based on the direction of deletion
            let insertIndex: number;
 
            switch (direction) {
                case 'forward':
                    insertIndex =
                        index > 0 && segments[index - 1].segmentType == 'SelectionMarker'
                            ? index - 1
                            : index;
                    break;
 
                case 'backward':
                    insertIndex =
                        index < segments.length && segments[index].segmentType == 'SelectionMarker'
                            ? index + 1
                            : index;
                    break;
 
                default:
                    insertIndex = index;
            }
 
            segments.splice(insertIndex, 0, segment);
        }
    }
}
 
function normalizePreviousSegment(
    paragraph: ReadonlyContentModelParagraph,
    segments: ReadonlyArray<ReadonlyContentModelSegment>,
    currentIndex: number
) {
    let index = currentIndex - 1;
 
    while (segments[index]?.segmentType == 'SelectionMarker') {
        index--;
    }
 
    const segment = segments[index];
 
    if (segment) {
        normalizeSingleSegment(paragraph, segment);
    }
}