2 #define _GNU_SOURCE /* memrchr(3) is non-standard */
15 #include <sys/types.h>
22 #include <selinux/selinux.h>
26 #include "text-util.h"
27 #include "text-motions.h"
30 /* Allocate blocks holding the actual file content in chunks of size: */
32 #define BLOCK_SIZE (1 << 20)
34 /* Files smaller than this value are copied on load, larger ones are mmap(2)-ed
35 * directely. Hence the former can be truncated, while doing so on the latter
36 * results in havoc. */
37 #define BLOCK_MMAP_SIZE (1 << 26)
39 /* Block holding the file content, either readonly mmap(2)-ed from the original
40 * file or heap allocated to store the modifications.
42 typedef struct Block Block
;
44 size_t size
; /* maximal capacity */
45 size_t len
; /* current used length / insertion position */
46 char *data
; /* actual data */
47 enum { /* type of allocation */
48 MMAP_ORIG
, /* mmap(2)-ed from an external file */
49 MMAP
, /* mmap(2)-ed from a temporary file only known to this process */
50 MALLOC
, /* heap allocated block using malloc(3) */
52 Block
*next
; /* next chunk */
55 /* A piece holds a reference (but doesn't itself store) a certain amount of data.
56 * All active pieces chained together form the whole content of the document.
57 * At the beginning there exists only one piece, spanning the whole document.
58 * Upon insertion/deletion new pieces will be created to represent the changes.
59 * Generally pieces are never destroyed, but kept around to peform undo/redo
63 Text
*text
; /* text to which this piece belongs */
64 Piece
*prev
, *next
; /* pointers to the logical predecessor/successor */
65 Piece
*global_prev
; /* double linked list in order of allocation, */
66 Piece
*global_next
; /* used to free individual pieces */
67 const char *data
; /* pointer into a Block holding the data */
68 size_t len
; /* the length in number of bytes of the data */
71 /* used to transform a global position (byte offset starting from the beginning
72 * of the text) into an offset relative to a piece.
75 Piece
*piece
; /* piece holding the location */
76 size_t off
; /* offset into the piece in bytes */
79 /* A Span holds a certain range of pieces. Changes to the document are always
80 * performed by swapping out an existing span with a new one.
83 Piece
*start
, *end
; /* start/end of the span */
84 size_t len
; /* the sum of the lengths of the pieces which form this span */
87 /* A Change keeps all needed information to redo/undo an insertion/deletion. */
88 typedef struct Change Change
;
90 Span old
; /* all pieces which are being modified/swapped out by the change */
91 Span
new; /* all pieces which are introduced/swapped in by the change */
92 size_t pos
; /* absolute position at which the change occured */
93 Change
*next
; /* next change which is part of the same revision */
94 Change
*prev
; /* previous change which is part of the same revision */
97 /* A Revision is a list of Changes which are used to undo/redo all modifications
98 * since the last snapshot operation. Revisions are stored in a directed graph structure.
100 typedef struct Revision Revision
;
102 Change
*change
; /* the most recent change */
103 Revision
*next
; /* the next (child) revision in the undo tree */
104 Revision
*prev
; /* the previous (parent) revision in the undo tree */
105 Revision
*earlier
; /* the previous Revision, chronologically */
106 Revision
*later
; /* the next Revision, chronologically */
107 time_t time
; /* when the first change of this revision was performed */
108 size_t seq
; /* a unique, strictly increasing identifier */
112 size_t pos
; /* position in bytes from start of file */
113 size_t lineno
; /* line number in file i.e. number of '\n' in [0, pos) */
116 /* The main struct holding all information of a given file */
118 Block
*block
; /* original file content at the time of load operation */
119 Block
*blocks
; /* all blocks which have been allocated to hold insertion data */
120 Piece
*pieces
; /* all pieces which have been allocated, used to free them */
121 Piece
*cache
; /* most recently modified piece */
122 Piece begin
, end
; /* sentinel nodes which always exists but don't hold any data */
123 Revision
*history
; /* undo tree */
124 Revision
*current_revision
; /* revision holding all file changes until a snapshot is performed */
125 Revision
*last_revision
; /* the last revision added to the tree, chronologically */
126 Revision
*saved_revision
; /* the last revision at the time of the save operation */
127 size_t size
; /* current file content size in bytes */
128 struct stat info
; /* stat as probed at load time */
129 LineCache lines
; /* mapping between absolute pos in bytes and logical line breaks */
132 struct TextSave
{ /* used to hold context between text_save_{begin,commit} calls */
133 Text
*txt
; /* text to operate on */
134 char *filename
; /* filename to save to as given to text_save_begin */
135 char *tmpname
; /* temporary name used for atomic rename(2) */
136 int fd
; /* file descriptor to write data to using text_save_write */
137 int dirfd
; /* directory file descriptor, relative to which we save */
138 enum TextSaveMethod type
; /* method used to save file */
141 /* block management */
142 static Block
*block_alloc(Text
*, size_t size
);
143 static Block
*block_read(Text
*, size_t size
, int fd
);
144 static Block
*block_mmap(Text
*, size_t size
, int fd
, off_t offset
);
145 static void block_free(Block
*);
146 static bool block_capacity(Block
*, size_t len
);
147 static const char *block_append(Block
*, const char *data
, size_t len
);
148 static bool block_insert(Block
*, size_t pos
, const char *data
, size_t len
);
149 static bool block_delete(Block
*, size_t pos
, size_t len
);
150 static const char *block_store(Text
*, const char *data
, size_t len
);
152 static void cache_piece(Text
*txt
, Piece
*p
);
153 static bool cache_contains(Text
*txt
, Piece
*p
);
154 static bool cache_insert(Text
*txt
, Piece
*p
, size_t off
, const char *data
, size_t len
);
155 static bool cache_delete(Text
*txt
, Piece
*p
, size_t off
, size_t len
);
156 /* piece management */
157 static Piece
*piece_alloc(Text
*txt
);
158 static void piece_free(Piece
*p
);
159 static void piece_init(Piece
*p
, Piece
*prev
, Piece
*next
, const char *data
, size_t len
);
160 static Location
piece_get_intern(Text
*txt
, size_t pos
);
161 static Location
piece_get_extern(Text
*txt
, size_t pos
);
162 /* span management */
163 static void span_init(Span
*span
, Piece
*start
, Piece
*end
);
164 static void span_swap(Text
*txt
, Span
*old
, Span
*new);
165 /* change management */
166 static Change
*change_alloc(Text
*txt
, size_t pos
);
167 static void change_free(Change
*c
);
168 /* revision management */
169 static Revision
*revision_alloc(Text
*txt
);
170 static void revision_free(Revision
*rev
);
171 /* logical line counting cache */
172 static void lineno_cache_invalidate(LineCache
*cache
);
173 static size_t lines_skip_forward(Text
*txt
, size_t pos
, size_t lines
, size_t *lines_skiped
);
174 static size_t lines_count(Text
*txt
, size_t pos
, size_t len
);
176 static ssize_t
write_all(int fd
, const char *buf
, size_t count
) {
179 ssize_t written
= write(fd
, buf
, rem
> INT_MAX
? INT_MAX
: rem
);
181 if (errno
== EAGAIN
|| errno
== EINTR
)
184 } else if (written
== 0) {
193 /* allocate a new block of MAX(size, BLOCK_SIZE) bytes */
194 static Block
*block_alloc(Text
*txt
, size_t size
) {
195 Block
*blk
= calloc(1, sizeof *blk
);
198 if (BLOCK_SIZE
> size
)
200 if (!(blk
->data
= malloc(size
))) {
206 blk
->next
= txt
->blocks
;
211 static Block
*block_read(Text
*txt
, size_t size
, int fd
) {
212 Block
*blk
= block_alloc(txt
, size
);
217 ssize_t len
= read(fd
, data
, MIN(sizeof(data
), size
));
219 txt
->blocks
= blk
->next
;
222 } else if (len
== 0) {
225 block_append(blk
, data
, len
);
232 static Block
*block_mmap(Text
*txt
, size_t size
, int fd
, off_t offset
) {
233 Block
*blk
= calloc(1, sizeof *blk
);
237 blk
->data
= mmap(NULL
, size
, PROT_READ
, MAP_SHARED
, fd
, offset
);
238 if (blk
->data
== MAP_FAILED
) {
243 blk
->type
= MMAP_ORIG
;
246 blk
->next
= txt
->blocks
;
251 static void block_free(Block
*blk
) {
254 if (blk
->type
== MALLOC
)
256 else if ((blk
->type
== MMAP_ORIG
|| blk
->type
== MMAP
) && blk
->data
)
257 munmap(blk
->data
, blk
->size
);
261 /* check whether block has enough free space to store len bytes */
262 static bool block_capacity(Block
*blk
, size_t len
) {
263 return blk
->size
- blk
->len
>= len
;
266 /* append data to block, assumes there is enough space available */
267 static const char *block_append(Block
*blk
, const char *data
, size_t len
) {
268 char *dest
= memcpy(blk
->data
+ blk
->len
, data
, len
);
273 /* stores the given data in a block, allocates a new one if necessary. returns
274 * a pointer to the storage location or NULL if allocation failed. */
275 static const char *block_store(Text
*txt
, const char *data
, size_t len
) {
276 Block
*blk
= txt
->blocks
;
277 if ((!blk
|| !block_capacity(blk
, len
)) && !(blk
= block_alloc(txt
, len
)))
279 return block_append(blk
, data
, len
);
282 /* insert data into block at an arbitrary position, this should only be used with
283 * data of the most recently created piece. */
284 static bool block_insert(Block
*blk
, size_t pos
, const char *data
, size_t len
) {
285 if (pos
> blk
->len
|| !block_capacity(blk
, len
))
288 return block_append(blk
, data
, len
);
289 char *insert
= blk
->data
+ pos
;
290 memmove(insert
+ len
, insert
, blk
->len
- pos
);
291 memcpy(insert
, data
, len
);
296 /* delete data from a block at an arbitrary position, this should only be used with
297 * data of the most recently created piece. */
298 static bool block_delete(Block
*blk
, size_t pos
, size_t len
) {
300 if (!addu(pos
, len
, &end
) || end
> blk
->len
)
302 if (blk
->len
== pos
) {
306 char *delete = blk
->data
+ pos
;
307 memmove(delete, delete + len
, blk
->len
- pos
- len
);
312 /* cache the given piece if it is the most recently changed one */
313 static void cache_piece(Text
*txt
, Piece
*p
) {
314 Block
*blk
= txt
->blocks
;
315 if (!blk
|| p
->data
< blk
->data
|| p
->data
+ p
->len
!= blk
->data
+ blk
->len
)
320 /* check whether the given piece was the most recently modified one */
321 static bool cache_contains(Text
*txt
, Piece
*p
) {
322 Block
*blk
= txt
->blocks
;
323 Revision
*rev
= txt
->current_revision
;
324 if (!blk
|| !txt
->cache
|| txt
->cache
!= p
|| !rev
|| !rev
->change
)
327 Piece
*start
= rev
->change
->new.start
;
328 Piece
*end
= rev
->change
->new.end
;
330 for (Piece
*cur
= start
; !found
; cur
= cur
->next
) {
337 return found
&& p
->data
+ p
->len
== blk
->data
+ blk
->len
;
340 /* try to insert a chunk of data at a given piece offset. the insertion is only
341 * performed if the piece is the most recenetly changed one. the legnth of the
342 * piece, the span containing it and the whole text is adjusted accordingly */
343 static bool cache_insert(Text
*txt
, Piece
*p
, size_t off
, const char *data
, size_t len
) {
344 if (!cache_contains(txt
, p
))
346 Block
*blk
= txt
->blocks
;
347 size_t bufpos
= p
->data
+ off
- blk
->data
;
348 if (!block_insert(blk
, bufpos
, data
, len
))
351 txt
->current_revision
->change
->new.len
+= len
;
356 /* try to delete a chunk of data at a given piece offset. the deletion is only
357 * performed if the piece is the most recenetly changed one and the whole
358 * affected range lies within it. the legnth of the piece, the span containing it
359 * and the whole text is adjusted accordingly */
360 static bool cache_delete(Text
*txt
, Piece
*p
, size_t off
, size_t len
) {
361 if (!cache_contains(txt
, p
))
363 Block
*blk
= txt
->blocks
;
365 size_t bufpos
= p
->data
+ off
- blk
->data
;
366 if (!addu(off
, len
, &end
) || end
> p
->len
|| !block_delete(blk
, bufpos
, len
))
369 txt
->current_revision
->change
->new.len
-= len
;
374 /* initialize a span and calculate its length */
375 static void span_init(Span
*span
, Piece
*start
, Piece
*end
) {
379 for (Piece
*p
= start
; p
; p
= p
->next
) {
387 /* swap out an old span and replace it with a new one.
389 * - if old is an empty span do not remove anything, just insert the new one
390 * - if new is an empty span do not insert anything, just remove the old one
392 * adjusts the document size accordingly.
394 static void span_swap(Text
*txt
, Span
*old
, Span
*new) {
395 if (old
->len
== 0 && new->len
== 0) {
397 } else if (old
->len
== 0) {
398 /* insert new span */
399 new->start
->prev
->next
= new->start
;
400 new->end
->next
->prev
= new->end
;
401 } else if (new->len
== 0) {
402 /* delete old span */
403 old
->start
->prev
->next
= old
->end
->next
;
404 old
->end
->next
->prev
= old
->start
->prev
;
406 /* replace old with new */
407 old
->start
->prev
->next
= new->start
;
408 old
->end
->next
->prev
= new->end
;
410 txt
->size
-= old
->len
;
411 txt
->size
+= new->len
;
414 /* Allocate a new revision and place it in the revision graph.
415 * All further changes will be associated with this revision. */
416 static Revision
*revision_alloc(Text
*txt
) {
417 Revision
*rev
= calloc(1, sizeof *rev
);
420 rev
->time
= time(NULL
);
421 txt
->current_revision
= rev
;
423 /* set sequence number */
424 if (!txt
->last_revision
)
427 rev
->seq
= txt
->last_revision
->seq
+ 1;
429 /* set earlier, later pointers */
430 if (txt
->last_revision
)
431 txt
->last_revision
->later
= rev
;
432 rev
->earlier
= txt
->last_revision
;
439 /* set prev, next pointers */
440 rev
->prev
= txt
->history
;
441 txt
->history
->next
= rev
;
446 static void revision_free(Revision
*rev
) {
449 for (Change
*next
, *c
= rev
->change
; c
; c
= next
) {
456 static Piece
*piece_alloc(Text
*txt
) {
457 Piece
*p
= calloc(1, sizeof *p
);
461 p
->global_next
= txt
->pieces
;
463 txt
->pieces
->global_prev
= p
;
468 static void piece_free(Piece
*p
) {
472 p
->global_prev
->global_next
= p
->global_next
;
474 p
->global_next
->global_prev
= p
->global_prev
;
475 if (p
->text
->pieces
== p
)
476 p
->text
->pieces
= p
->global_next
;
477 if (p
->text
->cache
== p
)
478 p
->text
->cache
= NULL
;
482 static void piece_init(Piece
*p
, Piece
*prev
, Piece
*next
, const char *data
, size_t len
) {
489 /* returns the piece holding the text at byte offset pos. if pos happens to
490 * be at a piece boundry i.e. the first byte of a piece then the previous piece
491 * to the left is returned with an offset of piece->len. this is convenient for
492 * modifications to the piece chain where both pieces (the returned one and the
493 * one following it) are needed, but unsuitable as a public interface.
495 * in particular if pos is zero, the begin sentinel piece is returned.
497 static Location
piece_get_intern(Text
*txt
, size_t pos
) {
499 for (Piece
*p
= &txt
->begin
; p
->next
; p
= p
->next
) {
500 if (cur
<= pos
&& pos
<= cur
+ p
->len
)
501 return (Location
){ .piece
= p
, .off
= pos
- cur
};
505 return (Location
){ 0 };
508 /* similiar to piece_get_intern but usable as a public API. returns the piece
509 * holding the text at byte offset pos. never returns a sentinel piece.
510 * it pos is the end of file (== text_size()) and the file is not empty then
511 * the last piece holding data is returned.
513 static Location
piece_get_extern(Text
*txt
, size_t pos
) {
517 for (p
= txt
->begin
.next
; p
->next
; p
= p
->next
) {
518 if (cur
<= pos
&& pos
< cur
+ p
->len
)
519 return (Location
){ .piece
= p
, .off
= pos
- cur
};
524 return (Location
){ .piece
= p
->prev
, .off
= p
->prev
->len
};
526 return (Location
){ 0 };
529 /* allocate a new change, associate it with current revision or a newly
530 * allocated one if none exists. */
531 static Change
*change_alloc(Text
*txt
, size_t pos
) {
532 Revision
*rev
= txt
->current_revision
;
534 rev
= revision_alloc(txt
);
538 Change
*c
= calloc(1, sizeof *c
);
542 c
->next
= rev
->change
;
544 rev
->change
->prev
= c
;
549 static void change_free(Change
*c
) {
552 /* only free the new part of the span, the old one is still in use */
553 if (c
->new.start
!= c
->new.end
)
554 piece_free(c
->new.end
);
555 piece_free(c
->new.start
);
559 /* When inserting new data there are 2 cases to consider.
561 * - in the first the insertion point falls into the middle of an exisiting
562 * piece which is replaced by three new pieces:
564 * /-+ --> +---------------+ --> +-\
565 * | | | existing text | | |
566 * \-+ <-- +---------------+ <-- +-/
568 * Insertion point for "demo "
570 * /-+ --> +---------+ --> +-----+ --> +-----+ --> +-\
571 * | | | existing| |demo | |text | | |
572 * \-+ <-- +---------+ <-- +-----+ <-- +-----+ <-- +-/
574 * - the second case deals with an insertion point at a piece boundry:
576 * /-+ --> +---------------+ --> +-\
577 * | | | existing text | | |
578 * \-+ <-- +---------------+ <-- +-/
580 * Insertion point for "short"
582 * /-+ --> +-----+ --> +---------------+ --> +-\
583 * | | |short| | existing text | | |
584 * \-+ <-- +-----+ <-- +---------------+ <-- +-/
586 bool text_insert(Text
*txt
, size_t pos
, const char *data
, size_t len
) {
591 if (pos
< txt
->lines
.pos
)
592 lineno_cache_invalidate(&txt
->lines
);
594 Location loc
= piece_get_intern(txt
, pos
);
595 Piece
*p
= loc
.piece
;
598 size_t off
= loc
.off
;
599 if (cache_insert(txt
, p
, off
, data
, len
))
602 Change
*c
= change_alloc(txt
, pos
);
606 if (!(data
= block_store(txt
, data
, len
)))
612 /* insert between two existing pieces, hence there is nothing to
613 * remove, just add a new piece holding the extra text */
614 if (!(new = piece_alloc(txt
)))
616 piece_init(new, p
, p
->next
, data
, len
);
617 span_init(&c
->new, new, new);
618 span_init(&c
->old
, NULL
, NULL
);
620 /* insert into middle of an existing piece, therfore split the old
621 * piece. that is we have 3 new pieces one containing the content
622 * before the insertion point then one holding the newly inserted
623 * text and one holding the content after the insertion point.
625 Piece
*before
= piece_alloc(txt
);
626 new = piece_alloc(txt
);
627 Piece
*after
= piece_alloc(txt
);
628 if (!before
|| !new || !after
)
630 piece_init(before
, p
->prev
, new, p
->data
, off
);
631 piece_init(new, before
, after
, data
, len
);
632 piece_init(after
, new, p
->next
, p
->data
+ off
, p
->len
- off
);
634 span_init(&c
->new, before
, after
);
635 span_init(&c
->old
, p
, p
);
638 cache_piece(txt
, new);
639 span_swap(txt
, &c
->old
, &c
->new);
643 static bool text_vprintf(Text
*txt
, size_t pos
, const char *format
, va_list ap
) {
645 va_copy(ap_save
, ap
);
646 int len
= vsnprintf(NULL
, 0, format
, ap
);
651 char *buf
= malloc(len
+1);
652 bool ret
= buf
&& (vsnprintf(buf
, len
+1, format
, ap_save
) == len
) && text_insert(txt
, pos
, buf
, len
);
658 bool text_appendf(Text
*txt
, const char *format
, ...) {
660 va_start(ap
, format
);
661 bool ret
= text_vprintf(txt
, text_size(txt
), format
, ap
);
666 bool text_printf(Text
*txt
, size_t pos
, const char *format
, ...) {
668 va_start(ap
, format
);
669 bool ret
= text_vprintf(txt
, pos
, format
, ap
);
674 static size_t revision_undo(Text
*txt
, Revision
*rev
) {
676 for (Change
*c
= rev
->change
; c
; c
= c
->next
) {
677 span_swap(txt
, &c
->new, &c
->old
);
683 static size_t revision_redo(Text
*txt
, Revision
*rev
) {
685 Change
*c
= rev
->change
;
688 for ( ; c
; c
= c
->prev
) {
689 span_swap(txt
, &c
->old
, &c
->new);
691 if (c
->new.len
> c
->old
.len
)
692 pos
+= c
->new.len
- c
->old
.len
;
697 size_t text_undo(Text
*txt
) {
699 /* taking rev snapshot makes sure that txt->current_revision is reset */
701 Revision
*rev
= txt
->history
->prev
;
704 pos
= revision_undo(txt
, txt
->history
);
706 lineno_cache_invalidate(&txt
->lines
);
710 size_t text_redo(Text
*txt
) {
712 /* taking a snapshot makes sure that txt->current_revision is reset */
714 Revision
*rev
= txt
->history
->next
;
717 pos
= revision_redo(txt
, rev
);
719 lineno_cache_invalidate(&txt
->lines
);
723 static bool history_change_branch(Revision
*rev
) {
724 bool changed
= false;
726 if (rev
->prev
->next
!= rev
) {
727 rev
->prev
->next
= rev
;
735 static size_t history_traverse_to(Text
*txt
, Revision
*rev
) {
739 bool changed
= history_change_branch(rev
);
741 if (rev
->seq
== txt
->history
->seq
) {
742 return txt
->lines
.pos
;
743 } else if (rev
->seq
> txt
->history
->seq
) {
744 while (txt
->history
!= rev
)
745 pos
= text_redo(txt
);
747 } else if (rev
->seq
< txt
->history
->seq
) {
748 while (txt
->history
!= rev
)
749 pos
= text_undo(txt
);
753 while (txt
->history
->prev
&& txt
->history
->prev
->next
== txt
->history
)
755 pos
= text_undo(txt
);
756 while (txt
->history
!= rev
)
757 pos
= text_redo(txt
);
763 size_t text_earlier(Text
*txt
) {
764 return history_traverse_to(txt
, txt
->history
->earlier
);
767 size_t text_later(Text
*txt
) {
768 return history_traverse_to(txt
, txt
->history
->later
);
771 size_t text_restore(Text
*txt
, time_t time
) {
772 Revision
*rev
= txt
->history
;
773 while (time
< rev
->time
&& rev
->earlier
)
775 while (time
> rev
->time
&& rev
->later
)
777 time_t diff
= labs(rev
->time
- time
);
778 if (rev
->earlier
&& rev
->earlier
!= txt
->history
&& labs(rev
->earlier
->time
- time
) < diff
)
780 if (rev
->later
&& rev
->later
!= txt
->history
&& labs(rev
->later
->time
- time
) < diff
)
782 return history_traverse_to(txt
, rev
);
785 time_t text_state(Text
*txt
) {
786 return txt
->history
->time
;
789 static bool preserve_acl(int src
, int dest
) {
791 acl_t acl
= acl_get_fd(src
);
793 return errno
== ENOTSUP
? true : false;
794 if (acl_set_fd(dest
, acl
) == -1) {
799 #endif /* CONFIG_ACL */
803 static bool preserve_selinux_context(int src
, int dest
) {
805 char *context
= NULL
;
806 if (!is_selinux_enabled())
808 if (fgetfilecon(src
, &context
) == -1)
809 return errno
== ENOTSUP
? true : false;
810 if (fsetfilecon(dest
, context
) == -1) {
815 #endif /* CONFIG_SELINUX */
819 static int mkstempat(int dirfd
, char *template) {
820 if (dirfd
== AT_FDCWD
)
821 return mkstemp(template);
822 // FIXME: not thread safe
824 int cwd
= open(".", O_RDONLY
|O_DIRECTORY
);
827 if (fchdir(dirfd
) == -1)
829 fd
= mkstemp(template);
838 /* Create a new file named `.filename.vis.XXXXXX` (where `XXXXXX` is a
839 * randomly generated, unique suffix) and try to preserve all important
840 * meta data. After the file content has been written to this temporary
841 * file, text_save_commit_atomic will atomically move it to its final
842 * (possibly already existing) destination using rename(2).
844 * This approach does not work if:
846 * - the file is a symbolic link
847 * - the file is a hard link
848 * - file ownership can not be preserved
849 * - file group can not be preserved
850 * - directory permissions do not allow creation of a new file
851 * - POSXI ACL can not be preserved (if enabled)
852 * - SELinux security context can not be preserved (if enabled)
854 static bool text_save_begin_atomic(TextSave
*ctx
) {
855 int oldfd
, saved_errno
;
856 if ((oldfd
= openat(ctx
->dirfd
, ctx
->filename
, O_RDONLY
)) == -1 && errno
!= ENOENT
)
858 struct stat oldmeta
= { 0 };
859 if (oldfd
!= -1 && fstatat(ctx
->dirfd
, ctx
->filename
, &oldmeta
, AT_SYMLINK_NOFOLLOW
) == -1)
862 if (S_ISLNK(oldmeta
.st_mode
)) /* symbolic link */
864 if (oldmeta
.st_nlink
> 1) /* hard link */
868 char suffix
[] = ".vis.XXXXXX";
869 size_t len
= strlen(ctx
->filename
) + sizeof("./.") + sizeof(suffix
);
870 char *dir
= strdup(ctx
->filename
);
871 char *base
= strdup(ctx
->filename
);
873 if (!(ctx
->tmpname
= malloc(len
)) || !dir
|| !base
) {
879 snprintf(ctx
->tmpname
, len
, "%s/.%s%s", dirname(dir
), basename(base
), suffix
);
883 if ((ctx
->fd
= mkstempat(ctx
->dirfd
, ctx
->tmpname
)) == -1)
887 mode_t mask
= umask(0);
889 if (fchmod(ctx
->fd
, 0666 & ~mask
) == -1)
892 if (fchmod(ctx
->fd
, oldmeta
.st_mode
) == -1)
894 if (!preserve_acl(oldfd
, ctx
->fd
) || !preserve_selinux_context(oldfd
, ctx
->fd
))
896 /* change owner if necessary */
897 if (oldmeta
.st_uid
!= getuid() && fchown(ctx
->fd
, oldmeta
.st_uid
, (uid_t
)-1) == -1)
899 /* change group if necessary, in case of failure some editors reset
900 * the group permissions to the same as for others */
901 if (oldmeta
.st_gid
!= getgid() && fchown(ctx
->fd
, (uid_t
)-1, oldmeta
.st_gid
) == -1)
906 ctx
->type
= TEXT_SAVE_ATOMIC
;
921 static bool text_save_commit_atomic(TextSave
*ctx
) {
922 if (fsync(ctx
->fd
) == -1)
925 struct stat meta
= { 0 };
926 if (fstat(ctx
->fd
, &meta
) == -1)
929 bool close_failed
= (close(ctx
->fd
) == -1);
934 if (renameat(ctx
->dirfd
, ctx
->tmpname
, ctx
->dirfd
, ctx
->filename
) == -1)
940 int dir
= openat(ctx
->dirfd
, dirname(ctx
->filename
), O_DIRECTORY
|O_RDONLY
);
944 if (fsync(dir
) == -1 && errno
!= EINVAL
) {
949 if (close(dir
) == -1)
953 ctx
->txt
->info
= meta
;
957 static bool text_save_begin_inplace(TextSave
*ctx
) {
958 Text
*txt
= ctx
->txt
;
959 struct stat meta
= { 0 };
960 int newfd
= -1, saved_errno
;
961 if ((ctx
->fd
= openat(ctx
->dirfd
, ctx
->filename
, O_CREAT
|O_WRONLY
, 0666)) == -1)
963 if (fstat(ctx
->fd
, &meta
) == -1)
965 Block
*block
= txt
->block
;
966 if (meta
.st_dev
== txt
->info
.st_dev
&& meta
.st_ino
== txt
->info
.st_ino
&&
967 block
&& block
->type
== MMAP_ORIG
&& block
->size
) {
968 /* The file we are going to overwrite is currently mmap-ed from
969 * text_load, therefore we copy the mmap-ed block to a temporary
970 * file and remap it at the same position such that all pointers
971 * from the various pieces are still valid.
973 size_t size
= block
->size
;
974 char tmpname
[32] = "/tmp/vis-XXXXXX";
975 newfd
= mkstemp(tmpname
);
978 if (unlink(tmpname
) == -1)
980 ssize_t written
= write_all(newfd
, block
->data
, size
);
981 if (written
== -1 || (size_t)written
!= size
)
983 void *data
= mmap(block
->data
, size
, PROT_READ
, MAP_SHARED
|MAP_FIXED
, newfd
, 0);
984 if (data
== MAP_FAILED
)
986 bool close_failed
= (close(newfd
) == -1);
992 /* overwrite the existing file content, if something goes wrong
993 * here we are screwed, TODO: make a backup before? */
994 if (ftruncate(ctx
->fd
, 0) == -1)
996 ctx
->type
= TEXT_SAVE_INPLACE
;
1005 errno
= saved_errno
;
1009 static bool text_save_commit_inplace(TextSave
*ctx
) {
1010 if (fsync(ctx
->fd
) == -1)
1012 struct stat meta
= { 0 };
1013 if (fstat(ctx
->fd
, &meta
) == -1)
1015 if (close(ctx
->fd
) == -1)
1017 ctx
->txt
->info
= meta
;
1021 TextSave
*text_save_begin(Text
*txt
, int dirfd
, const char *filename
, enum TextSaveMethod type
) {
1024 TextSave
*ctx
= calloc(1, sizeof *ctx
);
1030 if (!(ctx
->filename
= strdup(filename
)))
1033 if ((type
== TEXT_SAVE_AUTO
|| type
== TEXT_SAVE_ATOMIC
) && text_save_begin_atomic(ctx
))
1035 if (errno
== ENOSPC
)
1037 if ((type
== TEXT_SAVE_AUTO
|| type
== TEXT_SAVE_INPLACE
) && text_save_begin_inplace(ctx
))
1040 text_save_cancel(ctx
);
1044 bool text_save_commit(TextSave
*ctx
) {
1048 Text
*txt
= ctx
->txt
;
1049 switch (ctx
->type
) {
1050 case TEXT_SAVE_ATOMIC
:
1051 ret
= text_save_commit_atomic(ctx
);
1053 case TEXT_SAVE_INPLACE
:
1054 ret
= text_save_commit_inplace(ctx
);
1062 txt
->saved_revision
= txt
->history
;
1065 text_save_cancel(ctx
);
1069 void text_save_cancel(TextSave
*ctx
) {
1072 int saved_errno
= errno
;
1075 if (ctx
->tmpname
&& ctx
->tmpname
[0])
1076 unlinkat(ctx
->dirfd
, ctx
->tmpname
, 0);
1078 free(ctx
->filename
);
1080 errno
= saved_errno
;
1083 /* First try to save the file atomically using rename(2) if this does not
1084 * work overwrite the file in place. However if something goes wrong during
1085 * this overwrite the original file is permanently damaged.
1087 bool text_save(Text
*txt
, const char *filename
) {
1088 return text_saveat(txt
, AT_FDCWD
, filename
);
1091 bool text_saveat(Text
*txt
, int dirfd
, const char *filename
) {
1092 return text_saveat_method(txt
, dirfd
, filename
, TEXT_SAVE_AUTO
);
1095 bool text_save_method(Text
*txt
, const char *filename
, enum TextSaveMethod method
) {
1096 return text_saveat_method(txt
, AT_FDCWD
, filename
, method
);
1099 bool text_saveat_method(Text
*txt
, int dirfd
, const char *filename
, enum TextSaveMethod method
) {
1101 txt
->saved_revision
= txt
->history
;
1105 TextSave
*ctx
= text_save_begin(txt
, dirfd
, filename
, method
);
1108 Filerange range
= (Filerange
){ .start
= 0, .end
= text_size(txt
) };
1109 ssize_t written
= text_save_write_range(ctx
, &range
);
1110 if (written
== -1 || (size_t)written
!= text_range_size(&range
)) {
1111 text_save_cancel(ctx
);
1114 return text_save_commit(ctx
);
1117 ssize_t
text_save_write_range(TextSave
*ctx
, Filerange
*range
) {
1118 return text_write_range(ctx
->txt
, range
, ctx
->fd
);
1121 ssize_t
text_write(Text
*txt
, int fd
) {
1122 Filerange r
= (Filerange
){ .start
= 0, .end
= text_size(txt
) };
1123 return text_write_range(txt
, &r
, fd
);
1126 ssize_t
text_write_range(Text
*txt
, Filerange
*range
, int fd
) {
1127 size_t size
= text_range_size(range
), rem
= size
;
1128 for (Iterator it
= text_iterator_get(txt
, range
->start
);
1129 rem
> 0 && text_iterator_valid(&it
);
1130 text_iterator_next(&it
)) {
1131 size_t prem
= it
.end
- it
.text
;
1134 ssize_t written
= write_all(fd
, it
.text
, prem
);
1138 if ((size_t)written
!= prem
)
1144 Text
*text_load(const char *filename
) {
1145 return text_load_method(filename
, TEXT_LOAD_AUTO
);
1148 Text
*text_loadat(int dirfd
, const char *filename
) {
1149 return text_loadat_method(dirfd
, filename
, TEXT_LOAD_AUTO
);
1152 Text
*text_load_method(const char *filename
, enum TextLoadMethod method
) {
1153 return text_loadat_method(AT_FDCWD
, filename
, method
);
1156 Text
*text_loadat_method(int dirfd
, const char *filename
, enum TextLoadMethod method
) {
1159 Text
*txt
= calloc(1, sizeof *txt
);
1162 Piece
*p
= piece_alloc(txt
);
1165 lineno_cache_invalidate(&txt
->lines
);
1167 if ((fd
= openat(dirfd
, filename
, O_RDONLY
)) == -1)
1169 if (fstat(fd
, &txt
->info
) == -1)
1171 if (!S_ISREG(txt
->info
.st_mode
)) {
1172 errno
= S_ISDIR(txt
->info
.st_mode
) ? EISDIR
: ENOTSUP
;
1175 // XXX: use lseek(fd, 0, SEEK_END); instead?
1176 size
= txt
->info
.st_size
;
1178 if (method
== TEXT_LOAD_READ
|| (method
== TEXT_LOAD_AUTO
&& size
< BLOCK_MMAP_SIZE
))
1179 txt
->block
= block_read(txt
, size
, fd
);
1181 txt
->block
= block_mmap(txt
, size
, fd
, 0);
1184 piece_init(p
, &txt
->begin
, &txt
->end
, txt
->block
->data
, txt
->block
->len
);
1189 piece_init(p
, &txt
->begin
, &txt
->end
, "\0", 0);
1191 piece_init(&txt
->begin
, NULL
, p
, NULL
, 0);
1192 piece_init(&txt
->end
, p
, NULL
, NULL
, 0);
1194 /* write an empty revision */
1195 change_alloc(txt
, EPOS
);
1197 txt
->saved_revision
= txt
->history
;
1209 struct stat
text_stat(Text
*txt
) {
1213 /* A delete operation can either start/stop midway through a piece or at
1214 * a boundry. In the former case a new piece is created to represent the
1215 * remaining text before/after the modification point.
1217 * /-+ --> +---------+ --> +-----+ --> +-----+ --> +-\
1218 * | | | existing| |demo | |text | | |
1219 * \-+ <-- +---------+ <-- +-----+ <-- +-----+ <-- +-/
1221 * |------ delete range -----|
1223 * /-+ --> +----+ --> +--+ --> +-\
1224 * | | | exi| |t | | |
1225 * \-+ <-- +----+ <-- +--+ <-- +-/
1227 bool text_delete(Text
*txt
, size_t pos
, size_t len
) {
1231 if (!addu(pos
, len
, &pos_end
) || pos_end
> txt
->size
)
1233 if (pos
< txt
->lines
.pos
)
1234 lineno_cache_invalidate(&txt
->lines
);
1236 Location loc
= piece_get_intern(txt
, pos
);
1237 Piece
*p
= loc
.piece
;
1240 size_t off
= loc
.off
;
1241 if (cache_delete(txt
, p
, off
, len
))
1243 Change
*c
= change_alloc(txt
, pos
);
1247 bool midway_start
= false, midway_end
= false; /* split pieces? */
1248 Piece
*before
, *after
; /* unmodified pieces before/after deletion point */
1249 Piece
*start
, *end
; /* span which is removed */
1250 size_t cur
; /* how much has already been deleted */
1252 if (off
== p
->len
) {
1253 /* deletion starts at a piece boundry */
1258 /* deletion starts midway through a piece */
1259 midway_start
= true;
1262 before
= piece_alloc(txt
);
1267 /* skip all pieces which fall into deletion range */
1274 /* deletion stops at a piece boundry */
1278 /* cur > len: deletion stops midway through a piece */
1281 after
= piece_alloc(txt
);
1284 piece_init(after
, before
, p
->next
, p
->data
+ p
->len
- (cur
- len
), cur
- len
);
1288 /* we finally know which piece follows our newly allocated before piece */
1289 piece_init(before
, start
->prev
, after
, start
->data
, off
);
1292 Piece
*new_start
= NULL
, *new_end
= NULL
;
1304 span_init(&c
->new, new_start
, new_end
);
1305 span_init(&c
->old
, start
, end
);
1306 span_swap(txt
, &c
->old
, &c
->new);
1310 bool text_delete_range(Text
*txt
, Filerange
*r
) {
1311 if (!text_range_valid(r
))
1313 return text_delete(txt
, r
->start
, text_range_size(r
));
1316 /* preserve the current text content such that it can be restored by
1317 * means of undo/redo operations */
1318 void text_snapshot(Text
*txt
) {
1319 if (txt
->current_revision
)
1320 txt
->last_revision
= txt
->current_revision
;
1321 txt
->current_revision
= NULL
;
1326 void text_free(Text
*txt
) {
1331 Revision
*hist
= txt
->history
;
1332 while (hist
&& hist
->prev
)
1335 Revision
*later
= hist
->later
;
1336 revision_free(hist
);
1340 for (Piece
*next
, *p
= txt
->pieces
; p
; p
= next
) {
1341 next
= p
->global_next
;
1345 for (Block
*next
, *blk
= txt
->blocks
; blk
; blk
= next
) {
1353 bool text_modified(Text
*txt
) {
1354 return txt
->saved_revision
!= txt
->history
;
1357 bool text_mmaped(Text
*txt
, const char *ptr
) {
1358 uintptr_t addr
= (uintptr_t)ptr
;
1359 for (Block
*blk
= txt
->blocks
; blk
; blk
= blk
->next
) {
1360 if ((blk
->type
== MMAP_ORIG
|| blk
->type
== MMAP
) &&
1361 (uintptr_t)(blk
->data
) <= addr
&& addr
< (uintptr_t)(blk
->data
+ blk
->size
))
1367 static bool text_iterator_init(Iterator
*it
, size_t pos
, Piece
*p
, size_t off
) {
1368 Iterator iter
= (Iterator
){
1371 .start
= p
? p
->data
: NULL
,
1372 .end
= p
? p
->data
+ p
->len
: NULL
,
1373 .text
= p
? p
->data
+ off
: NULL
,
1376 return text_iterator_valid(it
);
1379 Iterator
text_iterator_get(Text
*txt
, size_t pos
) {
1381 Location loc
= piece_get_extern(txt
, pos
);
1382 text_iterator_init(&it
, pos
, loc
.piece
, loc
.off
);
1386 bool text_iterator_byte_get(Iterator
*it
, char *b
) {
1387 if (text_iterator_valid(it
)) {
1388 if (it
->start
<= it
->text
&& it
->text
< it
->end
) {
1391 } else if (it
->pos
== it
->piece
->text
->size
) { /* EOF */
1399 bool text_iterator_next(Iterator
*it
) {
1400 size_t rem
= it
->end
- it
->text
;
1401 return text_iterator_init(it
, it
->pos
+rem
, it
->piece
? it
->piece
->next
: NULL
, 0);
1404 bool text_iterator_prev(Iterator
*it
) {
1405 size_t off
= it
->text
- it
->start
;
1406 size_t len
= it
->piece
&& it
->piece
->prev
? it
->piece
->prev
->len
: 0;
1407 return text_iterator_init(it
, it
->pos
-off
, it
->piece
? it
->piece
->prev
: NULL
, len
);
1410 bool text_iterator_valid(const Iterator
*it
) {
1411 /* filter out sentinel nodes */
1412 return it
->piece
&& it
->piece
->text
;
1415 bool text_iterator_byte_next(Iterator
*it
, char *b
) {
1416 if (!it
->piece
|| !it
->piece
->next
)
1419 if (it
->text
< it
->end
) {
1423 } else if (!it
->piece
->prev
) {
1427 while (it
->text
== it
->end
) {
1428 if (!text_iterator_next(it
)) {
1433 return text_iterator_prev(it
);
1442 bool text_iterator_byte_prev(Iterator
*it
, char *b
) {
1443 if (!it
->piece
|| !it
->piece
->prev
)
1445 bool eof
= !it
->piece
->next
;
1446 while (it
->text
== it
->start
) {
1447 if (!text_iterator_prev(it
)) {
1452 return text_iterator_next(it
);
1464 bool text_iterator_byte_find_prev(Iterator
*it
, char b
) {
1466 const char *match
= memrchr(it
->start
, b
, it
->text
- it
->start
);
1468 it
->pos
-= it
->text
- match
;
1472 text_iterator_prev(it
);
1474 text_iterator_next(it
);
1478 bool text_iterator_byte_find_next(Iterator
*it
, char b
) {
1480 const char *match
= memchr(it
->text
, b
, it
->end
- it
->text
);
1482 it
->pos
+= match
- it
->text
;
1486 text_iterator_next(it
);
1488 text_iterator_prev(it
);
1492 bool text_iterator_codepoint_next(Iterator
*it
, char *c
) {
1493 while (text_iterator_byte_next(it
, NULL
)) {
1494 if (ISUTF8(*it
->text
)) {
1503 bool text_iterator_codepoint_prev(Iterator
*it
, char *c
) {
1504 while (text_iterator_byte_prev(it
, NULL
)) {
1505 if (ISUTF8(*it
->text
)) {
1514 bool text_iterator_char_next(Iterator
*it
, char *c
) {
1515 if (!text_iterator_codepoint_next(it
, c
))
1517 mbstate_t ps
= { 0 };
1519 char buf
[MB_LEN_MAX
];
1520 size_t len
= text_bytes_get(it
->piece
->text
, it
->pos
, sizeof buf
, buf
);
1522 size_t wclen
= mbrtowc(&wc
, buf
, len
, &ps
);
1523 if (wclen
== (size_t)-1 && errno
== EILSEQ
) {
1525 } else if (wclen
== (size_t)-2) {
1527 } else if (wclen
== 0) {
1530 int width
= wcwidth(wc
);
1533 if (!text_iterator_codepoint_next(it
, c
))
1540 bool text_iterator_char_prev(Iterator
*it
, char *c
) {
1541 if (!text_iterator_codepoint_prev(it
, c
))
1544 char buf
[MB_LEN_MAX
];
1545 size_t len
= text_bytes_get(it
->piece
->text
, it
->pos
, sizeof buf
, buf
);
1547 mbstate_t ps
= { 0 };
1548 size_t wclen
= mbrtowc(&wc
, buf
, len
, &ps
);
1549 if (wclen
== (size_t)-1 && errno
== EILSEQ
) {
1551 } else if (wclen
== (size_t)-2) {
1553 } else if (wclen
== 0) {
1556 int width
= wcwidth(wc
);
1559 if (!text_iterator_codepoint_prev(it
, c
))
1566 bool text_byte_get(Text
*txt
, size_t pos
, char *byte
) {
1567 return text_bytes_get(txt
, pos
, 1, byte
);
1570 size_t text_bytes_get(Text
*txt
, size_t pos
, size_t len
, char *buf
) {
1575 for (Iterator it
= text_iterator_get(txt
, pos
);
1576 text_iterator_valid(&it
);
1577 text_iterator_next(&it
)) {
1580 size_t piece_len
= it
.end
- it
.text
;
1581 if (piece_len
> rem
)
1584 memcpy(cur
, it
.text
, piece_len
);
1592 char *text_bytes_alloc0(Text
*txt
, size_t pos
, size_t len
) {
1593 if (len
== SIZE_MAX
)
1595 char *buf
= malloc(len
+1);
1598 len
= text_bytes_get(txt
, pos
, len
, buf
);
1603 size_t text_size(Text
*txt
) {
1607 /* count the number of new lines '\n' in range [pos, pos+len) */
1608 static size_t lines_count(Text
*txt
, size_t pos
, size_t len
) {
1610 for (Iterator it
= text_iterator_get(txt
, pos
);
1611 text_iterator_valid(&it
);
1612 text_iterator_next(&it
)) {
1613 const char *start
= it
.text
;
1614 while (len
> 0 && start
< it
.end
) {
1615 size_t n
= MIN(len
, (size_t)(it
.end
- start
));
1616 const char *end
= memchr(start
, '\n', n
);
1622 len
-= end
- start
+ 1;
1632 /* skip n lines forward and return position afterwards */
1633 static size_t lines_skip_forward(Text
*txt
, size_t pos
, size_t lines
, size_t *lines_skipped
) {
1634 size_t lines_old
= lines
;
1635 for (Iterator it
= text_iterator_get(txt
, pos
);
1636 text_iterator_valid(&it
);
1637 text_iterator_next(&it
)) {
1638 const char *start
= it
.text
;
1639 while (lines
> 0 && start
< it
.end
) {
1640 size_t n
= it
.end
- start
;
1641 const char *end
= memchr(start
, '\n', n
);
1646 pos
+= end
- start
+ 1;
1655 *lines_skipped
= lines_old
- lines
;
1659 static void lineno_cache_invalidate(LineCache
*cache
) {
1664 size_t text_pos_by_lineno(Text
*txt
, size_t lineno
) {
1665 size_t lines_skipped
;
1666 LineCache
*cache
= &txt
->lines
;
1669 if (lineno
> cache
->lineno
) {
1670 cache
->pos
= lines_skip_forward(txt
, cache
->pos
, lineno
- cache
->lineno
, &lines_skipped
);
1671 cache
->lineno
+= lines_skipped
;
1672 } else if (lineno
< cache
->lineno
) {
1674 // TODO does it make sense to scan memory backwards here?
1675 size_t diff
= cache
->lineno
- lineno
;
1676 if (diff
< lineno
) {
1677 lines_skip_backward(txt
, cache
->pos
, diff
);
1680 cache
->pos
= lines_skip_forward(txt
, 0, lineno
- 1, &lines_skipped
);
1681 cache
->lineno
= lines_skipped
+ 1;
1683 return cache
->lineno
== lineno
? cache
->pos
: EPOS
;
1686 size_t text_lineno_by_pos(Text
*txt
, size_t pos
) {
1687 LineCache
*cache
= &txt
->lines
;
1688 if (pos
> txt
->size
)
1690 if (pos
< cache
->pos
) {
1691 size_t diff
= cache
->pos
- pos
;
1693 cache
->lineno
-= lines_count(txt
, pos
, diff
);
1695 cache
->lineno
= lines_count(txt
, 0, pos
) + 1;
1696 } else if (pos
> cache
->pos
) {
1697 cache
->lineno
+= lines_count(txt
, cache
->pos
, pos
- cache
->pos
);
1699 cache
->pos
= text_line_begin(txt
, pos
);
1700 return cache
->lineno
;
1703 Mark
text_mark_set(Text
*txt
, size_t pos
) {
1704 if (pos
== txt
->size
)
1705 return (Mark
)&txt
->end
;
1706 Location loc
= piece_get_extern(txt
, pos
);
1709 return (Mark
)(loc
.piece
->data
+ loc
.off
);
1712 size_t text_mark_get(Text
*txt
, Mark mark
) {
1717 if (mark
== (Mark
)&txt
->end
)
1720 for (Piece
*p
= txt
->begin
.next
; p
->next
; p
= p
->next
) {
1721 Mark start
= (Mark
)(p
->data
);
1722 Mark end
= start
+ p
->len
;
1723 if (start
<= mark
&& mark
< end
)
1724 return cur
+ (mark
- start
);