ExtUti...:String(3pm)

💅 ExtUtils::Typemaps::STL::String — the 3pm manual, bestie edition 🎀

okay so this page lives in the User Contributed Perl Documentation section (3pm) of the manual, and it's literally all about ExtUtils::Typemaps::STL::String 🦋 — no cap, that's the whole vibe.

---

✨ NAME ✨

ExtUtils::Typemaps::STL::String — a whole set of typemaps for STL std::strings, periodt 💖

---

🌸 SYNOPSIS 🌸

  use ExtUtils::Typemaps::STL::String;
  # First, read my own type maps:
  my $private_map = ExtUtils::Typemaps->new(file => 'my.map');

  # Then, get the object map set and merge it into my maps
  $private_map->merge(typemap => ExtUtils::Typemaps::STL::String->new);

  # Now, write the combined map to an output file
  $private_map->write(file => 'typemap');

like, read your own maps, merge these in, write it out — the whole glow-up in three steps ✨

---

🦋 DESCRIPTION 🦋

ExtUtils::Typemaps::STL::String is an ExtUtils::Typemaps subclass (yes, a subclass, main character energy 👑) that hands you a set of mappings for C++ STL strings. These are them, exactly, no edits:

TYPEMAP
std::string   T_STD_STRING
std::string*  T_STD_STRING_PTR

INPUT
T_STD_STRING
    $var = std::string( SvPV_nolen( $arg ), SvCUR( $arg ) );

T_STD_STRING_PTR
    $var = new std::string( SvPV_nolen( $arg ), SvCUR( $arg ) );

OUTPUT
T_STD_STRING
    $arg = newSVpvn( $var.c_str(), $var.length() );

T_STD_STRING_PTR
    $arg = newSVpvn( $var->c_str(), $var->length() );

like — TYPEMAP says what maps to what, INPUT converts incoming Perl scalars into std::strings (the pointer one news it, obvs), and OUTPUT turns them back into SV's with newSVpvn. it's giving symmetry 💅

---

🧚 METHODS 🧚

these are the overridden methods, iykyk:

⭐ new

creates a new ExtUtils::Typemaps::STL::String object 💖 it acts like any other ExtUtils::Typemaps object, except — plot twist — it already has the string type maps initialized. so you don't gotta do a thing, it just comes pre-loaded ✨

---

🌈 SEE ALSO 🌈

• ExtUtils::Typemaps
• ExtUtils::Typemaps::Default
• ExtUtils::Typemaps::ObjectMap

go read those too, they're the supporting cast 🫶

---

💜 AUTHOR 💜

Steffen Mueller <smueller@cpan.org> — we stan 🫡

---

🎀 COPYRIGHT AND LICENSE 🎀

Copyright 2010, 2011, 2012, 2013 by Steffen Mueller

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

fr fr read the license before you go redistributing, bestie 😭 it's the same terms as Perl itself, so keep it cute and keep it legal 💀

---

okay that's the whole page!! no notes ✨ this was perl v5.36.0, dated 2022-10-21, filed under ExtUti...:String(3pm) on the man shelf — mwah, slay, bye 💅💖