GOLF(2gg)

✨ GOLF(2gg) ✨

okay bestie, welcome to the GOLF(2gg) page, Development section, and we're talking about the cutest little linked-list mover you ever did see 💅

---

🌸 NAME 🌸

position-list — (linked-list)

---

🎯 PURPOSE 🎯

Set the current element in a linked list. That's it. That's the whole job. Iconic behaviour, honestly 🫶

---

📜 SYNTAX 📜

position-list <list> \
    [ first | last | end | previous | next | \
    [ status <status> ]

(no cap, that bracket situation is exactly how it's written, we don't question the ancestors 🙈)

---

💖 DESCRIPTION 💖

position-list changes the current element of the linked <list>. And what even is a current element, you ask? It's the one you read with read-list, periodt. A newly added element gets written with write-list by inserting it just before the current element, which means that fresh baby becomes the new current element 👑. Reading from <list> does not change its current element — nope, not even a little — so if you actually wanna move it, you use position-list to explicitly change it. That's the whole vibe.

To position to the first element, use the first clause. Use the last clause to make the last element the current one. And use previous and next to change the current element to just before or just after it. Simple. Clean. Slay ✨

A position just beyond the last element in <list> is considered the "end" of it. In that case, write-list will append an element to <list> and this element becomes its last — which is, lowkey, equivalent to using the write-list statement with the append clause. Same energy, different route 💫

Use the end clause to set the current element to <list>'s end. Note that the end clause is equivalent to using the next clause on the last element in <list>. Yes bestie, they're the same thing, we said what we said.

😭 Now for the part where you gotta pay attention: if you attempt to position prior to the first element, after the end of <list>, or anywhere in an empty list, then the <status> number (in the status clause) is GG_ERR_EXIST, otherwise it's GG_OKAY. And note — if <status> is GG_ERR_EXIST, the current element will not change. It stays exactly where it was. No sneaky movement. Zero. None. 💀

---

🧚 EXAMPLES 🧚

Position to the next element in list:

position-list mylist next status st
if-true st equal GG_ERR_EXIST
    @Beyond the end of list
end-if

Position to the first element in list:

position-list mylist first

---

🦋 SEE ALSO 🦋

• Linked list
• delete-list
• get-list
• new-list
• position-list
• purge-list
• read-list
• write-list
• See all documentation

---

and that's the whole page, bestie!! go forth and position your elements responsibly 🌈✨💖

this has been GOLF(2gg), dated $DATE, version $VERSION — stay slaying, drink water, and may your current element always be exactly where you left it 🎀🫶👑