From d9021235b07b60ed76d1f7e02223897f5afccbb7 Mon Sep 17 00:00:00 2001 From: Father Chrysostomos Date: Tue, 20 Sep 2011 15:39:32 -0700 Subject: Document and apiify hv name length/utf8 macros --- hv.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'hv.h') diff --git a/hv.h b/hv.h index 4eafcc6cf2..78f377160f 100644 --- a/hv.h +++ b/hv.h @@ -175,6 +175,12 @@ Null HV pointer. Returns the package name of a stash, or NULL if C isn't a stash. See C, C. +=for apidoc Am|STRLEN|HvNAMELEN|HV *stash +Returns the length of the stash's name. + +=for apidoc Am|unsigned char|HvNAMEUTF8|HV *stash +Returns true if the name is in UTF8 encoding. + =for apidoc Am|char*|HvENAME|HV* stash Returns the effective name of a stash, or NULL if there is none. The effective name represents a location in the symbol table where this stash @@ -183,6 +189,12 @@ A stash that is no longer in the symbol table has no effective name. This name is preferable to C for use in MRO linearisations and isa caches. +=for apidoc Am|STRLEN|HvENAMELEN|HV *stash +Returns the length of the stash's effective name. + +=for apidoc Am|unsigned char|HvENAMEUTF8|HV *stash +Returns true if the effective name is in UTF8 encoding. + =for apidoc Am|void*|HeKEY|HE* he Returns the actual pointer stored in the key slot of the hash entry. The pointer may be either C or C, depending on the value of -- cgit v1.2.1