mtext_pop_prop(3m17n)

🌸 mtext_pop_prop — from the m17n Library, bestie 💖

okay so we're diving into mtext_pop_prop(3m17n) and honestly? it's giving "quietly essential" and i'm obsessed. let's get into it 🎀

---

✨ NAME ✨

mtext_pop_prop — the little function that yeets the topmost text property off your characters 💅

---

🦋 SYNOPSIS 🦋

int mtext_pop_prop (MText * mt, int from, int to, MSymbol key)

like look at that signature. clean. simple. iconic. no notes 👑

---

💜 DESCRIPTION 💜

@brief Pop a text property.

so here's the tea ☕ — mtext_pop_prop() removes the topmost text property whose key is key from the characters between from (inclusive, bestie, we count it) and to (exclusive, we do NOT count it) inside mt.

and listen — if the characters in that region have no such text property? this function literally does nothing. no drama, no error, just vibes. 🙈

with this function, this:

                    FROM                    TO
M-text: |<------------|-------- MT ---------|------------>|
PROP  :  <------------------ OLD_VAL -------------------->

becomes this:

                    FROM                    TO
M-text: |<------------|-------- MT ---------|------------>|
PROP  :  <--OLD_VAL-->|                     |<--OLD_VAL-->|

like?? the way it just scoops OLD_VAL right out of the middle and leaves it chillin' on both sides 🧚✨ the range in between? cleared. gone. unbothered. that's the whole point of a pop — topmost property only, no cap 🫶

💖 Return value 💖

if the operation was successful, mtext_pop_prop() returns 0 — slay, we love a zero 🎉

otherwise it returns -1 and assigns an error code to the external variable #merror_code — so always check that variable if you get a -1, fr fr 😭

🍓 Errors 🍓

• MERROR_RANGE
• MERROR_SYMBOL

those are the two you might catch, so keep an eye out 👀

🌈 See Also 🌈

• mtext_put_prop()
• mtext_put_prop_values()
• mtext_get_prop()
• mtext_get_prop_values()
• mtext_push_prop()
• mtext_prop_range()

the whole text-property friend group, honestly 💕 go say hi to all of them.

---

👑 COPYRIGHT 👑

Copyright (C) 2001 Information-technology Promotion Agency (IPA)

Copyright (C) 2001-2011 National Institute of Advanced Industrial Science and Technology (AIST)

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License <http://www.gnu.org/licenses/fdl.html>.

---

and that's the whole page, bestie 💖 this was Version 1.8.4, dated Mon Sep 25 2023 — m17n Library, mtext_pop_prop(3m17n), periodt. now go pop those props and stay hydrated 🫶✨🎀