Next: , Up: Kill Ring Protocol


18.4.8.1 Kill Ring Protocol Specification

— Class: drei-kill-ring:kill-ring

Class precedence list: kill-ring, standard-object, slot-object, t

Slots:

A class for all kill rings

— Generic Function: drei-kill-ring:kill-ring-max-size kr

Returns the value of the kill ring's maximum size

— Generic Function: drei-kill-ring:kill-ring-length kr

Returns the current length of the kill-ring. Note this is different than kill-ring-max-size.

— Generic Function: drei-kill-ring:kill-ring-standard-push kr vector

Pushes a vector of objects onto the kill ring creating a new start of ring position. This function is much like an everyday Lisp push with size considerations. If the length of the kill ring is greater than the maximum size, then "older" elements will be removed from the ring until the maximum size is reached.

— Generic Function: drei-kill-ring:kill-ring-concatenating-push kr vector

Concatenates the contents of vector onto the end of the current contents of the top of the kill ring. If the kill ring is empty the a new entry is pushed.

— Generic Function: drei-kill-ring:kill-ring-reverse-concatenating-push kr vector

Concatenates the contents of vector onto the front of the current contents of the top of the kill ring. If the kill ring is empty a new entry is pushed.

— Generic Function: drei-kill-ring:rotate-yank-position kr &optional times

Moves the yank point associated with a kill-ring one or times many positions away from the start of ring position. If times is greater than the current length then the cursor will wrap to the start of ring position and continue rotating.

— Generic Function: drei-kill-ring:reset-yank-position kr

Moves the current yank point back to the start of of kill ring position

— Generic Function: drei-kill-ring:kill-ring-yank kr &optional reset

Returns the vector of objects currently pointed to by the cursor. If reset is t, a call to reset-yank-position is called before the object is yanked. The default for reset is NIL. If the kill ring is empty, a condition of type empty-kill-ring is signalled.