sc::ParsedKeyVal(3)

💅 sc::ParsedKeyVal — the MPQC manual page, bestie

Okay so this is the whole tea on sc::ParsedKeyVal from the MPQC manual, and yes it’s giving “text goes in, keyword/value assocations come out” energy. 🎀

---

🌸 NAME

sc::ParsedKeyVal — converts textual information into keyword/value assocations. Yes, that’s the spelling on the page, and honestly? Iconic. 😭

---

✨ SYNOPSIS

#include <keyval.h>

Inherits sc::StringKeyVal. Slay. 👑

---

👑 Public Member Functions

• ParsedKeyVal () — creates an empty ParsedKeyVal. Blank canvas, main character energy. 🦋
• ParsedKeyVal (const char *file) — parses the given input file.
• ParsedKeyVal (std::istream &s) — reads input from s.
• ParsedKeyVal (IPV2 *) — uses the given IPV2* object.
• ParsedKeyVal (const char *, const Ref< KeyVal > &) — this ctor gets a string that’s used to form keywords sought in the keyval argument.
• ~ParsedKeyVal () — cleanup time, deleting the IPV2 object. 💅
• void read (const char *) — reads input data from the given filename.
• void read (std::istream &) — reads input data from the given stream.
• void parse_string (const char *) — reads input data from the given string.

🌟 Overrides of parent members.

See parent class documentation. That’s the whole note, bestie. 🫶

• const char * stringrep (const char *) — returns the string representation of the value assigned to key.
• const char * classname (const char *) — returns the name of the exact class of the object at the keyword.
• const char * truekeyword (const char *) — returns a string which is the actual keyword if some sort of variable substitution takes place (needed to make multiple references to the same object work in input files).
• void errortrace (std::ostream &fp=ExEnv::err0()) — writes a message to fp describing the error.
• void dump (std::ostream &fp=ExEnv::err0()) — writes a message to fp describing the error.
• void print_unseen (std::ostream &fp=ExEnv::out0()) — prints keywords that were never looked at, if possible.
• int have_unseen () — returns 1 if there were unseen keywords, 0 if there are none, or -1 if this keyval doesn’t keep track of unseen keywords.

---

⭐ Static Public Member Functions

• static void cat_files (const char *, const Ref< KeyVal > &, std::ostream &o) — this is like the ParsedKeyVal(const char*,const Ref<KeyVal>&) ctor, but writes the contents of the files to the given ostream o. Cute. 🎀

---

🫶 Additional Inherited Members

There are additional inherited members, and the page just says that. No extra deets here, bestie. 😌

---

🌈 Detailed Description

Converts textual information into keyword/value assocations.

The parsing is done with an IPV2 object. For the keyval tea on the input format, that’s where you look. 💖

---

🦋 Constructor & Destructor Documentation

🧚 sc::ParsedKeyVal::ParsedKeyVal (IPV2 *)

Use the given IPV2* object. The new ParsedKeyVal takes ownership of the passed IPV2 object. It said “wnership” in the source but we all know what she meant. 💀

🧚 sc::ParsedKeyVal::ParsedKeyVal (const char *, const Ref< KeyVal > &)

This ctor is given a string which is used to form keywords that are sought in the keyval argument. The associated values are used to construct file names that are used to initialize the ParsedKeyVal. The keywords sought are string'dir' for the directory prefix and string'files' for an array of file names. Periodt. ✨

---

💜 Member Function Documentation

💖 const char* sc::ParsedKeyVal::classname (const char *) [virtual]

Returns the name of the exact class of the object at the keyword. If no classname is assigned then 0 is returned.

Reimplemented from sc::StringKeyVal. 👑

---

🎀 Author

Generated automatically by Doxygen for MPQC from the source code. She was built by the machine, bestie. 🤖💅

---

okay that’s the whole page! 💖 This one is version 2.3.1, dated Sun Oct 4 2020, and the manpage is sc::ParsedKeyVal(3). Laterrr! 🦋🌷