Parse:...ttings(3pm)

💖 Parse::PlainConfig::Settings — the settings class, bestie 💖

okay so real talk: this is part of the User Contributed Perl Documentation, and the page you're looking at is Parse:...ttings(3pm) (yes the title got squished, that's just how it renders, don't panic 🫶). It's the lil settings object that Parse::PlainConfig spins up for you. Let's get into it. ✨

---

🌸 NAME 🌸

Parse::PlainConfig::Settings — it's the Settings Class, literally just that. The vault where all the default config-format vibes live. 🔐

---

🎀 VERSION 🎀

This is the version string, copied exactly, no edits, no notes:

$Id: lib/Parse/PlainConfig/Settings.pm, 3.07 2024/01/10 13:32:06
acorliss Exp $

So like, version 3.07, dated 2024/01/10 13:32:06, authored by acorliss. Iconic. 👑

---

✨ SYNOPSIS ✨

Here's the whole vibe check in code form — you make one, then you ask it stuff:

use Parse::PlainConfig::Settings;

my $settings = new Parse::PlainConfig::Settings;

$ts         = $settings->tabStop;
$subindent  = $settings->subindentation;
$comment    = $settings->comment;
$delim      = $settings->delimiter;
$ldelim     = $settings->listDelimiter;
$hdelim     = $settings->hashDelimiter;
$hdoc       = $settings->hereDoc;
%propTypes  = $settings->propertyTypes;
%propRegex  = $settings->propertyRegexes;
%prototypes = $settings->prototypes;
%protoRegex = $settings->prototypeRegexes;

Look at all those accessors. She's got range. 💅

---

🦋 DESCRIPTION 🦋

ngl the description is short and it's giving confident:

The settings object is created and initialized automatically by Parse::PlainConfig.

That's it, that's the whole thing. You do not have to build this yourself — Parse::PlainConfig handles it for you, automatically, on its own. You're just here to peek at the settings and maybe poke them. 🙈

---

🌈 SUBROUTINES/METHODS 🌈

Every single one of these is a getter, and every single one is gonna get its own lil moment. Let's go. 🫶

⭐ tabStop

$ts         = $settings->tabStop;

Default column width for tab stops. That's the number of columns a tab counts as, fr fr. 📏

⭐ subindentation

$subindent  = $settings->subindentation;

Default columns for indentation on line continuations. So when a line keeps going and going, this is how far it gets nudged over. 🪄

⭐ comment

$comment    = $settings->comment;

Default character sequence for comments. The lil marker that says "this bit is a note, not a setting". 💬

⭐ delimiter

$delim      = $settings->delimiter;

Default character sequence used as the delimiter between the parameter name and the parameter value. So like, name <—this thing—> value. The bridge. The hyphen in the situationship. 🌉

⭐ listDelimiter

$ldelim     = $settings->listDelimiter;

Default character sequence used as the delimiter between array elements. Keeping the array girlies separated but still in the same list. 🍓

⭐ hashDelimiter

$hdelim     = $settings->hashDelimiter;

Default character sequence used as the delimiter between key/value pairs. Every key deserves a value, and this is the little separator that makes it official. 💜

⭐ hereDoc

$hdoc       = $settings->hereDoc;

Default character sequence used as the token marking the end of here docs. The "we're done here" marker. Periodt. 🎬

⭐ propertyTypes

%propTypes  = $settings->propertyTypes;

Hash of property names => data types. A whole mapping, bestie. Lookup table behavior. 🗺️

⭐ propertyRegexes

%propRegex  = $settings->propertyRegexes;

Hash of property names to regular expression to extract data from the line. Yes, regexes, we love her, we fear her a little. 😭

⭐ prototypes

%prototypes = $settings->prototypes;

Hash of prototype names => data types. Same energy as propertyTypes but for prototypes. Sibling behavior. 👯

⭐ prototypeRegexes

%protoRegex = $settings->prototypeRegexes;

Hash of prototype names to regular expression to extract data from the line. The prototype version of the regex hash. She's consistent, she's reliable. 🔥

---

🧚 DEPENDENCIES 🧚

She does not stand alone, and honestly? Same. Here's the whole squad:

• Class::EHierarchy
• Paranoid
• Paranoid::Debug
• Parse::PlainConfig::Constants

---

💀 BUGS AND LIMITATIONS 💀

okay so bestie... this section is empty. Nothing documented here. No known bugs listed, no limitations listed. Which lowkey is a flex but also don't read that as a promise, iykyk. 🤷♀️

---

👑 AUTHOR 👑

Arthur Corliss (corliss@digitalmages.com) — the icon, the legend, the one who wrote it. 🫡

---

📜 LICENSE AND COPYRIGHT 📜

This software is licensed under the same terms as Perl, itself. Please see http://dev.perl.org/licenses/ for more information.

(c) 2016, Arthur Corliss (corliss@digitalmages.com)

---

and that's the whole page, bestie!! 🎀✨ This was documented for perl v5.38.2, dated 2024-01-20 — mwah, go forth and configure responsibly, ily 💖🦋🌸