This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix a cut-n-paste error.
[perl5.git] / pod / perlguts.pod
index 59c9fb0..d93eadf 100644 (file)
@@ -29,24 +29,34 @@ Additionally, there is the UV, which is simply an unsigned IV.
 
 Perl also uses two special typedefs, I32 and I16, which will always be at
 least 32-bits and 16-bits long, respectively. (Again, there are U32 and U16,
-as well.)
+as well.)  They will usually be exactly 32 and 16 bits long, but on Crays
+they will both be 64 bits.
 
 =head2 Working with SVs
 
-An SV can be created and loaded with one command.  There are four types of
-values that can be loaded: an integer value (IV), a double (NV),
-a string (PV), and another scalar (SV).
+An SV can be created and loaded with one command.  There are five types of
+values that can be loaded: an integer value (IV), an unsigned integer
+value (UV), a double (NV), a string (PV), and another scalar (SV).
 
-The six routines are:
+The seven routines are:
 
     SV*  newSViv(IV);
+    SV*  newSVuv(UV);
     SV*  newSVnv(double);
     SV*  newSVpv(const char*, int);
     SV*  newSVpvn(const char*, int);
     SV*  newSVpvf(const char*, ...);
     SV*  newSVsv(SV*);
 
-To change the value of an *already-existing* SV, there are seven routines:
+If you require more complex initialisation you can create an empty SV with
+newSV(len).  If C<len> is 0 an empty SV of type NULL is returned, else an
+SV of type PV is returned with len + 1 (for the NUL) bytes of storage
+allocated, accessible via SvPVX.  In both cases the SV has value undef.
+
+    SV*  newSV(0);   /* no storage allocated  */
+    SV*  newSV(10);  /* 10 (+1) bytes of uninitialised storage allocated  */
+
+To change the value of an *already-existing* SV, there are eight routines:
 
     void  sv_setiv(SV*, IV);
     void  sv_setuv(SV*, UV);
@@ -599,10 +609,25 @@ be set, using the routines appropriate to the data type.
 There are additional macros whose values may be bitwise OR'ed with the
 C<TRUE> argument to enable certain extra features.  Those bits are:
 
-    GV_ADDMULTI        Marks the variable as multiply defined, thus preventing the
-               "Name <varname> used only once: possible typo" warning.
-    GV_ADDWARN Issues the warning "Had to create <varname> unexpectedly" if
-               the variable did not exist before the function was called.
+=over
+
+=item GV_ADDMULTI
+
+Marks the variable as multiply defined, thus preventing the:
+
+  Name <varname> used only once: possible typo
+
+warning.
+
+=item GV_ADDWARN
+
+Issues the warning:
+
+  Had to create <varname> unexpectedly
+
+if the variable did not exist before the function was called.
+
+=back
 
 If you do not specify a package name, the variable is created in the current
 package.
@@ -674,7 +699,7 @@ The first call creates a mortal SV (with no value), the second converts an exist
 SV to a mortal SV (and thus defers a call to C<SvREFCNT_dec>), and the
 third creates a mortal copy of an existing SV.
 Because C<sv_newmortal> gives the new SV no value,it must normally be given one
-via C<sv_setpv>, C<sv_setiv> etc. :
+via C<sv_setpv>, C<sv_setiv>, etc. :
 
     SV *tmp = sv_newmortal();
     sv_setiv(tmp, an_integer);
@@ -1034,7 +1059,7 @@ you find yourself actually applying such information in this section, be
 aware that the behavior may change in the future, umm, without warning.
 
 The perl tie function associates a variable with an object that implements
-the various GET, SET etc methods.  To perform the equivalent of the perl
+the various GET, SET, etc methods.  To perform the equivalent of the perl
 tie function from an XSUB, you must mimic this behaviour.  The code below
 carries out the necessary steps - firstly it creates a new hash, and then
 creates a second hash which it blesses into the class which will implement
@@ -1128,7 +1153,7 @@ This construction is I<approximately> equivalent to
 
 The biggest difference is that the first construction would
 reinstate the initial value of $var, irrespective of how control exits
-the block: C<goto>, C<return>, C<die>/C<eval> etc. It is a little bit
+the block: C<goto>, C<return>, C<die>/C<eval>, etc. It is a little bit
 more efficient as well.
 
 There is a way to achieve a similar task from C via Perl API: create a
@@ -1342,7 +1367,7 @@ trapped, and how to treat return values.
 All four routines return the number of arguments that the subroutine returned
 on the Perl stack.
 
-These routines used to be called C<perl_call_sv> etc., before Perl v5.6.0,
+These routines used to be called C<perl_call_sv>, etc., before Perl v5.6.0,
 but those names are now deprecated; macros of the same name are provided for
 compatibility.
 
@@ -1490,7 +1515,7 @@ the scratchpad AV. In fact it contains a pointer to an AV of
 (initially) one element, and this element is the scratchpad AV. Why do
 we need an extra level of indirection?
 
-The answer is B<recursion>, and maybe (sometime soon) B<threads>. Both
+The answer is B<recursion>, and maybe B<threads>. Both
 these can create several execution pointers going into the same
 subroutine. For the subroutine-child not write over the temporaries
 for the subroutine-parent (lifespan of which covers the call to the
@@ -1731,7 +1756,7 @@ interpreters, with one interpreter represented either as a C structure,
 or inside a thread-specific structure.  These structures contain all
 the context, the state of that interpreter.
 
-Three macros control the major Perl build flavors: MULTIPLICITY, and
+Two macros control the major Perl build flavors: MULTIPLICITY and
 USE_5005THREADS.  The MULTIPLICITY build has a C structure
 that packages all the interpreter state, and there is a similar thread-specific
 data structure under USE_5005THREADS.  In both cases,
@@ -2342,7 +2367,7 @@ high character - C<HALF_UPGRADE> is one of those.
 
 =head1 Custom Operators
 
-Custom operator support is a new experimental feature that allows you do
+Custom operator support is a new experimental feature that allows you to
 define your own ops. This is primarily to allow the building of
 interpreters for other languages in the Perl core, but it also allows
 optimizations through the creation of "macro-ops" (ops which perform the