Next: , Previous: General Buffer Protocol Parts, Up: Buffer Protocol


18.4.1.2 Operations Related To The Offset Of Marks

— Generic Function: drei-buffer:forward-object mark &optional count

Move the mark forward the number of positions indicated by count. This function could be implemented by an incf on the offset of the mark, but many buffer implementations can implement this function much more efficiently in a different way. A motion-before-beginning condition is signaled if the resulting offset of the mark is less than zero. A motion-after-end condition is signaled if the resulting offset of the mark is greater than the size of the buffer. Returns mark.

— Generic Function: drei-buffer:backward-object mark &optional count

Move the mark backward the number of positions indicated by count. This function could be implemented by a decf on the offset of the mark, but many buffer implementations can implement this function much more efficiently in a different way. A motion-before-beginning condition is signaled if the resulting offset of the mark is less than zero. A motion-after-end condition is signaled if the resulting offset of the mark is greater than the size of the buffer. Returns mark.

— Generic Function: drei-buffer:mark= mark1 mark2

Return t if the offset of mark1 is equal to that of mark2. An error is signaled if the two marks are not positioned in the same buffer. It is acceptable to pass an offset in place of one of the marks.

— Generic Function: drei-buffer:mark< mark1 mark2

Return t if the offset of mark1 is strictly less than that of mark2. An error is signaled if the two marks are not positioned in the same buffer. It is acceptable to pass an offset in place of one of the marks.

— Generic Function: drei-buffer:mark<= mark1 mark2

Return t if the offset of mark1 is less than or equal to that of mark2. An error is signaled if the two marks are not positioned in the same buffer. It is acceptable to pass an offset in place of one of the marks.

— Generic Function: drei-buffer:mark> mark1 mark2

Return t if the offset of mark1 is strictly greater than that of mark2. An error is signaled if the two marks are not positioned in the same buffer. It is acceptable to pass an offset in place of one of the marks.

— Generic Function: drei-buffer:mark>= mark1 mark2

Return t if the offset of mark1 is greater than or equal to that of mark2. An error is signaled if the two marks are not positioned in the same buffer. It is acceptable to pass an offset in place of one of the marks.

— Generic Function: drei-buffer:beginning-of-buffer mark

Move the mark to the beginning of the buffer. This is equivalent to (setf (offset mark) 0), but returns mark.

— Generic Function: drei-buffer:end-of-buffer mark

Move the mark to the end of the buffer and return mark.

— Generic Function: drei-buffer:beginning-of-buffer-p mark

Return t if the mark is at the beginning of the buffer, nil otherwise.

— Generic Function: drei-buffer:end-of-buffer-p mark

Return t if the mark is at the end of the buffer, NIL otherwise.

— Generic Function: drei-buffer:beginning-of-line mark

Move the mark to the beginning of the line. The mark will be positioned either immediately after the closest receding newline character, or at the beginning of the buffer if no preceding newline character exists. Returns mark.

— Generic Function: drei-buffer:end-of-line mark

Move the mark to the end of the line. The mark will be positioned either immediately before the closest following newline character, or at the end of the buffer if no following newline character exists. Returns mark.

— Generic Function: drei-buffer:beginning-of-line-p mark

Return t if the mark is at the beginning of the line (i.e., if the character preceding the mark is a newline character or if the mark is at the beginning of the buffer), NIL otherwise.

— Generic Function: drei-buffer:end-of-line-p mark

Return t if the mark is at the end of the line (i.e., if the character following the mark is a newline character, or if the mark is at the end of the buffer), NIL otherwise.

— Generic Function: drei-buffer:buffer-line-number buffer offset

Return the line number of the offset. Lines are numbered from zero.

— Generic Function: drei-buffer:buffer-column-number buffer offset

Return the column number of the offset. The column number of an offset is the number of objects between it and the preceding newline, or between it and the beginning of the buffer if the offset is on the first line of the buffer.

— Generic Function: drei-buffer:line-number mark

Return the line number of the mark. Lines are numbered from zero.

— Generic Function: drei-buffer:column-number mark

Return the column number of the mark. The column number of a mark is the number of objects between it and the preceding newline, or between it and the beginning of the buffer if the mark is on the first line of the buffer.