m17nPlist(3m17n)

💖 m17nPlist 💖

okay bestie, welcome to the m17nPlist page, straight out of section 3m17n of The m17n Library docs. it's giving property list, it's giving data structure royalty, and we're gonna go through every single bit of it together. no skimming, no skipping, periodt. 🎀

---

✨ NAME ✨

m17nPlist — Property List 🗂️

---

🌸 SYNOPSIS 🌸

Functions

• MPlist * mplist_deserialize (MText *mt) — makes a whole new property list by deserializing an M-text. poof, plist. ✨
• MPlist * mplist (void) — creates a property list object from scratch. baby plist, fresh out the box. 🍼
• MPlist * mplist_copy (MPlist *plist) — copies a property list. twin energy fr fr. 👯
• MPlist * mplist_put (MPlist *plist, MSymbol key, void *val) — sets the value of a property inside a property list. 🎯
• void * mplist_get (MPlist *plist, MSymbol key) — gets the value of a property out of a property list. 👀
• MPlist * mplist_put_func (MPlist *plist, MSymbol key, M17NFunc func) — sets the value (a function pointer) of a property in a property list. 🧠
• M17NFunc mplist_get_func (MPlist *plist, MSymbol key) — gets the value (a function pointer) of a property in a property list. 🔍
• MPlist * mplist_add (MPlist *plist, MSymbol key, void *val) — adds a property at the end of a property list. 🔚
• MPlist * mplist_push (MPlist *plist, MSymbol key, void *val) — adds a property at the beginning of a property list. 🔝
• void * mplist_pop (MPlist *plist) — removes the property at the beginning of a property list. bye bestie 👋
• MPlist * mplist_find_by_key (MPlist *plist, MSymbol key) — finds a property with a specific key in a property list. 🕵️‍♀️
• MPlist * mplist_find_by_value (MPlist *plist, void *val) — finds a property with a specific value in a property list. 🕵️‍♀️
• MPlist * mplist_next (MPlist *plist) — returns the next sublist of a property list. ➡️
• MPlist * mplist_set (MPlist *plist, MSymbol key, void *val) — sets the first property in a property list. 🥇
• int mplist_length (MPlist *plist) — returns the length of a property list. 📏
• MSymbol mplist_key (MPlist *plist) — returns the key of the first property in a property list. 🔑
• void * mplist_value (MPlist *plist) — returns the value of the first property in a property list. 💎

Variables

• MSymbol Minteger — a symbol whose name is 'integer'. 🔢
• MSymbol Mplist — a symbol whose name is 'plist'. 📋
• MSymbol Mtext — a symbol whose name is 'mtext'. 📝

---

🦋 Detailed Description 🦋

@addtogroup m17nPlist

@brief Property List objects and API for them.

so. a property list (or plist for short, iykyk) is literally just a list of zero or more properties. and a property? it's a key plus a value. the key is a symbol, and the value is anything that can be cast to (void *). anything. the range. the audacity. 💅

now here's the tea: if the key of a property is a managing key, then its value is a managed object. and yes, a property list is itself a managed object. it manages, it's managed, it contains multitudes. 👑

and if every single key of a plist is one of #Msymbol, #Mtext, #Minteger, and #Mplist, then we call that plist well-formed — and it gets written out in the docs using this notation:

PLIST ::= '(' ELEMENT * ')'

ELEMENT ::= INTEGER | SYMBOL | M-TEXT | PLIST

M-TEXT ::= '"' text data ... '"'

for example, say a plist has four elements: the integer -20, a symbol of name "sym", an M-text with contents "abc", and a plist of the integer 10 and a symbol of name "another-symbol". then it's represented like this:

(-20 sym "abc" (10 another-symbol))

nested plists?? in my notation?? it's more likely than you think. 🌈

---

⭐ Variable Documentation ⭐

MSymbol Minteger

Symbol whose name is 'integer'. The symbol Minteger has the name 'integer'. The value of a property whose key is Minteger must be an integer. 🔢 no cap, it has to be an integer.

MSymbol Mplist

Symbol whose name is 'plist'. The symbol Mplist has the name 'plist'. It is a managing key. A value of a property whose key is Mplist must be a plist. 📋 managing key behavior, we love to see it.

MSymbol Mtext

Symbol whose name is 'mtext'. The symbol Mtext has the name 'mtext'. It is a managing key. A value of a property whose key is Mtext must be an M-text. 📝 again: managing key. again: must be an M-text.

---

🌈 Author 🌈

Generated automatically by Doxygen for The m17n Library from the source code. (yes the robot wrote it, and honestly? it ate. 🤖✨)

---

💜 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>.

---

okay that's the whole page bestie, you made it to the end, main character energy fr fr 🫶

Version 1.8.4 — dated Mon Sep 25 2023. mwah, that's a wrap on m17nPlist(3m17n), go forth and plist responsibly 💖✨🎀