WS Cleanup Stage #10 - reflow C comments (2)

Author: demerphq

cop.h

@@ -793,7 +793,8 @@ struct block_eval {
 
 /* loop context */
 struct block_loop {
-    LOOP    *my_op;         /* My op, that contains redo, next and last ops. */
+    LOOP    *my_op;         /* My op, that contains redo,
+                               next and last ops. */
     union { /* different ways of locating the iteration variable */
         SV  **svp;  /* for lexicals: address of pad slot */
         GV  *gv;    /* for package vars */
@@ -818,7 +819,8 @@ struct block_loop {
         }       lazysv;
     }       state_u;
 #ifdef USE_ITHREADS
-    PAD     *oldcomppad;    /* needed to map itervar_u.svp during thread clone */
+    PAD     *oldcomppad;    /* needed to map itervar_u.svp
+                               during thread clone */
 #endif
 };
 
@@ -1073,28 +1075,31 @@ struct context {
 
 /* extra flags for Perl_call_* routines */
 #define G_DISCARD              0x4  /* Call FREETMPS.  Don't change this
-                                   without consulting the hash
-                                   actions codes defined in hv.h */
-#define G_EVAL                 0x8  /* Assume eval {} around subroutine call. */
+                                       without consulting the hash
+                                       actions codes defined in hv.h */
+#define G_EVAL                 0x8  /* Assume eval {} around
+                                       subroutine call. */
 #define G_NOARGS              0x10  /* Don't construct a @_ array. */
 #define G_KEEPERR             0x20  /* Warn for errors, don't overwrite $@ */
 #define G_NODEBUG             0x40  /* Disable debugging at toplevel. */
 #define G_METHOD              0x80  /* Calling method. */
 #define G_FAKINGEVAL         0x100  /* Faking an eval context for call_sv
-                                   or fold_constants. */
+                                       or fold_constants. */
 #define G_UNDEF_FILL         0x200  /* Fill the stack with &PL_sv_undef
-                                   A special case for UNSHIFT in
-                                   Perl_magic_methcall(). */
+                                       A special case for UNSHIFT in
+                                       Perl_magic_methcall(). */
 #define G_WRITING_TO_STDERR  0x400  /* Perl_write_to_stderr() is calling
-                                     Perl_magic_methcall(). */
+                                       Perl_magic_methcall(). */
 #define G_RE_REPARSING       0x800  /* compiling a run-time /(?{..})/ */
-#define G_METHOD_NAMED      0x1000  /* calling named method, eg without :: or ' */
+#define G_METHOD_NAMED      0x1000  /* calling named method, eg
+                                       without :: or ' */
 #define G_RETHROW           0x2000  /* eval_sv(): re-throw any error */
 
 /* flag bits for PL_in_eval */
 #define EVAL_NULL                0  /* not in an eval */
 #define EVAL_INEVAL              1  /* some enclosing scope is an eval */
-#define EVAL_WARNONLY            2  /* used by yywarn() when calling yyerror() */
+#define EVAL_WARNONLY            2  /* used by yywarn() when
+                                       calling yyerror() */
 #define EVAL_KEEPERR             4  /* set by Perl_call_sv if G_KEEPERR */
 #define EVAL_INREQUIRE           8  /* The code is being required. */
 #define EVAL_RE_REPARSING     0x10  /* eval_sv() called with G_RE_REPARSING */
@@ -1135,7 +1140,7 @@ struct stackinfo {
                                          * #ifdef-ed for bincompat */
 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
     /* high water mark: for checking if the stack was correctly
- * extended / tested for extension by each pp function */
+     * extended / tested for extension by each pp function */
     SSize_t             si_stack_hwm;
 #endif
 

cv.h

@@ -118,30 +118,33 @@ L<perlguts/Autoloading with XSUBs>.
  * but is renamed to avoid collision with an upcoming feature */
 #define CVf_NOWARN_AMBIGUOUS  0x0001
 
-#define CVf_LVALUE           0x0002     /* CV return value can be used as lvalue */
+#define CVf_LVALUE           0x0002     /* CV return value can be
+                                           used as lvalue */
 #define CVf_CONST            0x0004     /* inlinable sub */
 #define CVf_ISXSUB           0x0008     /* CV is an XSUB, not pure perl. */
 
 #define CVf_WEAKOUTSIDE      0x0010     /* CvOUTSIDE isn't ref counted */
 #define CVf_CLONE            0x0020     /* anon CV uses external lexicals */
 #define CVf_CLONED           0x0040     /* a clone of one of those */
 #define CVf_ANON             0x0080     /* CV is not pointed to by a GV */
-#define CVf_UNIQUE           0x0100     /* sub is only called once (eg PL_main_cv,
-                                   require, eval). */
-#define CVf_NODEBUG          0x0200     /* no DB::sub indirection for this CV (esp.
-                                   useful for special XSUBs) */
+#define CVf_UNIQUE           0x0100     /* sub is only called once (eg
+                                           PL_main_cv, require, eval). */
+#define CVf_NODEBUG          0x0200     /* no DB::sub indirection for this CV
+                                           (esp.  useful for special XSUBs) */
 #define CVf_CVGV_RC          0x0400     /* CvGV is reference counted */
 #if defined(PERL_CORE) || defined(PERL_EXT)
 # define CVf_SLABBED      0x0800 /* Holds refcount on op slab */
 #endif
 #define CVf_DYNFILE          0x1000     /* The filename is malloced */
-#define CVf_AUTOLOAD         0x2000     /* SvPVX contains AUTOLOADed sub name */
+#define CVf_AUTOLOAD         0x2000     /* SvPVX contains AUTOLOADed
+                                           sub name */
 #define CVf_HASEVAL          0x4000     /* contains string eval */
 #define CVf_NAMED            0x8000     /* Has a name HEK */
 #define CVf_LEXICAL         0x10000     /* Omit package from name */
 #define CVf_ANONCONST       0x20000     /* :const - create anonconst op */
 #define CVf_SIGNATURE       0x40000     /* CV uses a signature */
-#define CVf_REFCOUNTED_ANYSV 0x80000     /* CvXSUBANY().any_sv is refcounted */
+#define CVf_REFCOUNTED_ANYSV 0x80000     /* CvXSUBANY().any_sv
+                                            is refcounted */
 
 /* This symbol for optimised communication between toke.c and op.c: */
 #define CVf_BUILTIN_ATTRS       (CVf_NOWARN_AMBIGUOUS|CVf_LVALUE|CVf_ANONCONST)

dosish.h

@@ -22,7 +22,7 @@
 #  define PERL_SYS_INIT_BODY(c,v)   \
        MALLOC_CHECK_TAINT2(*c,*v); PERLIO_INIT
 #  define BIT_BUCKET  "\\dev\\nul"    /* "wanna be like, umm, Newlined,
-                                     or somethin?" */
+                                         or somethin?" */
 #endif
 
 /* Generally add things last-in first-terminated.  IO and memory

form.h

@@ -13,10 +13,10 @@
 #define FF_SKIP          3  /* skip <arg> chars in format */
 #define FF_FETCH         4  /* get next item and set field size to <arg> */
 #define FF_CHECKNL       5  /* find max len of item (up to
-                              \n) that fits field */
+                               \n) that fits field */
 #define FF_CHECKCHOP     6  /* like CHECKNL, but up to highest split point */
 #define FF_SPACE         7  /* append padding space (diff
-                              of field, item size) */
+                               of field, item size) */
 #define FF_HALFSPACE     8  /* like FF_SPACE, but only append half as many */
 #define FF_ITEM          9  /* append a text item, while blanking ctrl chars */
 #define FF_CHOP         10  /* (for ^*) chop the current item */

gv.h

@@ -232,9 +232,11 @@ Return the CV from the GV.
                                    time, so don't try to free what's there. */
 #define GV_ADDMULTI       0x02  /* add, pretending it has been added already;
                                    used also by gv_init_* */
-#define GV_ADDWARN        0x04  /* add, but warn if symbol wasn't already there */
-                /*   0x08 UNUSED */
-#define GV_NOINIT         0x10  /* add, but don't init symbol, if type != PVGV */
+#define GV_ADDWARN        0x04  /* add, but warn if symbol wasn't
+                                   already there */
+                /* 0x08 UNUSED */
+#define GV_NOINIT         0x10  /* add, but don't init symbol,
+                                   if type != PVGV */
 /* This is used by toke.c to avoid turing placeholder constants in the symbol
    table into full PVGVs with attached constant subroutines. */
 #define GV_NOADD_NOINIT   0x20  /* Don't add the symbol if it's not there.
@@ -258,8 +260,8 @@ Return the CV from the GV.
 /* Flags for gv_autoload_ */
 #define GV_AUTOLOAD_ISMETHOD      1 /* autoloading a method? */
 
-/*   SVf_UTF8 (more accurately the return value from SvUTF8) is also valid as
-     a flag to various gv_* functions, so ensure it lies outside this range.
+/* SVf_UTF8 (more accurately the return value from SvUTF8) is also valid as
+   a flag to various gv_* functions, so ensure it lies outside this range.
  */
 
 #define GV_NOADD_MASK   \

handy.h

@@ -1610,7 +1610,7 @@ END_EXTERN_C
 #   define isSPACE_A(c)            generic_isCC_A_(c, CC_SPACE_)
 #   define isWORDCHAR_A(c)         generic_isCC_A_(c, CC_WORDCHAR_)
 #   define isXDIGIT_A(c)           generic_isCC_(c, CC_XDIGIT_) /* No non-ASCII
-                                                          xdigits */
+                                                                   xdigits */
 #   define isIDFIRST_A(c)          generic_isCC_A_(c, CC_IDFIRST_)
 #   define isALPHA_L1(c)           generic_isCC_(c, CC_ALPHA_)
 #   define isALPHANUMERIC_L1(c)    generic_isCC_(c, CC_ALPHANUMERIC_)
@@ -1857,7 +1857,8 @@ END_EXTERN_C
     ((! FITS_IN_8_BITS(c))  \
     ? (c)                   \
     : PL_latin1_lc[ (U8) (c) ])
-#define toLOWER_L1(c)               toLOWER_LATIN1(c)       /* Synonym for consistency */
+#define toLOWER_L1(c)               toLOWER_LATIN1(c)       /* Synonym for
+                                                               consistency */
 
 /* Modified uc.  Is correct uc except for three non-ascii chars
  * which are all mapped to one of them, and these need special
@@ -2137,7 +2138,8 @@ END_EXTERN_C
 #define isALPHANUMERIC_uvchr(c)     generic_invlist_uvchr_(CC_ALPHANUMERIC_, c)
 #define isASCII_uvchr(c)            isASCII(c)
 #define isBLANK_uvchr(c)            generic_uvchr_(CC_BLANK_, is_HORIZWS_cp_high, c)
-#define isCNTRL_uvchr(c)            isCNTRL_L1(c)           /* All controls are in Latin1 */
+#define isCNTRL_uvchr(c)            isCNTRL_L1(c)           /* All controls are
+                                                               in Latin1 */
 #define isDIGIT_uvchr(c)            generic_invlist_uvchr_(CC_DIGIT_, c)
 #define isGRAPH_uvchr(c)            generic_invlist_uvchr_(CC_GRAPH_, c)
 #define isIDCONT_uvchr(c)   \
@@ -2485,7 +2487,7 @@ END_EXTERN_C
 #define isALNUM_LC_utf8(p,e)        isWORDCHAR_LC_utf8(p,e)
 #define isALNUM_LC_utf8_safe(p,e)   isWORDCHAR_LC_utf8_safe(p,e)
 #define isALNUMC_A(c)               isALPHANUMERIC_A(c)     /* Mnemonic: "C's
-                                                        alnum" */
+                                                               alnum" */
 #define isALNUMC_L1(c)              isALPHANUMERIC_L1(c)
 #define isALNUMC(c)                 isALPHANUMERIC(c)
 #define isALNUMC_LC(c)              isALPHANUMERIC_LC(c)

hv.h

@@ -77,7 +77,8 @@ struct mro_alg {
     AV          *(*resolve)(pTHX_ HV* stash, U32 level);
     const char  *name;
     U16         length;
-    U16         kflags;                     /* For the hash API - set HVhek_UTF8 if name is UTF-8 */
+    U16         kflags;                     /* For the hash API - set
+                                               HVhek_UTF8 if name is UTF-8 */
     U32         hash;                       /* or 0 */
 };
 
@@ -89,13 +90,19 @@ struct mro_meta {
        value stored in and owned by mro_linear_all. */
     SV                      *mro_linear_current;
     HV                      *mro_nextmethod;        /* next::method caching */
-    U32                     cache_gen;              /* Bumping this invalidates our method cache */
-    U32                     pkg_gen;                /* Bumps when local methods/@ISA change */
-    const struct mro_alg    *mro_which;             /* which mro alg is in use? */
-    HV                      *isa;                   /* Everything this class @ISA */
+    U32                     cache_gen;              /* Bumping this invalidates
+                                                       our method cache */
+    U32                     pkg_gen;                /* Bumps when local
+                                                       methods/@ISA change */
+    const struct mro_alg    *mro_which;             /* which mro alg is
+                                                       in use? */
+    HV                      *isa;                   /* Everything this
+                                                       class @ISA */
     HV                      *super;                 /* SUPER method cache */
-    CV                      *destroy;               /* DESTROY method if destroy_gen non-zero */
-    U32                     destroy_gen;            /* Generation number of DESTROY cache */
+    CV                      *destroy;               /* DESTROY method if
+                                                       destroy_gen non-zero */
+    U32                     destroy_gen;            /* Generation number of
+                                                       DESTROY cache */
 };
 
 #define MRO_GET_PRIVATE_DATA(smeta, which)                  \
@@ -113,29 +120,34 @@ union _xhvnameu {
 
 struct xpvhv_aux {
     union _xhvnameu xhv_name_u;             /* name, if a symbol table */
-    AV              *xhv_backreferences;    /* back references for weak references */
+    AV              *xhv_backreferences;    /* back references for
+                                               weak references */
     HE              *xhv_eiter;             /* current entry of iterator */
     I32             xhv_riter;              /* current root of iterator */
 
-    /* Concerning xhv_name_count: When non-zero, xhv_name_u contains a pointer
- * to an array of HEK pointers, this being the length.  The first element is
- * the name of the stash, which may be NULL.  If xhv_name_count is positive,
- * then *xhv_name is one of the effective names.  If xhv_name_count is nega-
- * tive, then xhv_name_u.xhvnameu_names[1] is the first effective name.
- */
+    /* Concerning xhv_name_count: When non-zero, xhv_name_u contains
+     * a pointer to an array of HEK pointers, this being the length.
+     * The first element is the name of the stash, which may be
+     * NULL.  If xhv_name_count is positive, then *xhv_name is one of
+     * the effective names.  If xhv_name_count is nega- tive, then
+     * xhv_name_u.xhvnameu_names[1] is the first effective name.
+     */
     I32             xhv_name_count;
     struct mro_meta *xhv_mro_meta;
 #ifdef PERL_HASH_RANDOMIZE_KEYS
-    U32             xhv_rand;               /* random value for hash traversal */
-    U32             xhv_last_rand;          /* last random value for hash traversal,
-                                               used to detect each() after insert
-                                               for warnings */
+    U32             xhv_rand;               /* random value for hash
+                                               traversal */
+    U32             xhv_last_rand;          /* last random value for hash
+                                               traversal, used to detect each()
+                                               after insert for warnings */
 #endif
     U32             xhv_aux_flags;          /* assorted extra flags */
 };
 
-#define HvAUXf_SCAN_STASH           0x1     /* stash is being scanned by gv_check */
-#define HvAUXf_NO_DEREF             0x2     /* @{}, %{} etc (and nomethod) not present */
+#define HvAUXf_SCAN_STASH           0x1     /* stash is being scanned
+                                               by gv_check */
+#define HvAUXf_NO_DEREF             0x2     /* @{}, %{} etc (and nomethod)
+                                               not present */
 
 /* hash structure: */
 /* This structure must match the beginning of struct xpvmg in sv.h. */
@@ -150,7 +162,8 @@ struct xpvhv_with_aux {
     HV                  *xmg_stash; /* class package */
     union _xmgu         xmg_u;
     STRLEN              xhv_keys;   /* total keys, including placeholders */
-    STRLEN              xhv_max;    /* subscript of last element of xhv_array */
+    STRLEN              xhv_max;    /* subscript of last element
+                                       of xhv_array */
     struct xpvhv_aux    xhv_aux;
 };
 
@@ -438,16 +451,18 @@ Use this to check whether it is valid to call C<HvAUX()>.
 
 #define HVhek_UTF8           0x01   /* Key is utf8 encoded. */
 #define HVhek_WASUTF8        0x02   /* Key is bytes here, but was
-                                supplied as utf8. */
+                                       supplied as utf8. */
 #define HVhek_NOTSHARED      0x04   /* This key isn't a shared hash key. */
 /* the following flags are options for functions,
    they are not stored in heks */
-#define HVhek_FREEKEY       0x100   /* Internal flag to say key is Newx()ed. */
-#define HVhek_PLACEHOLD     0x200   /* Internal flag to create placeholder.  (may
-                               * change, but Storable is a core module) */
+#define HVhek_FREEKEY       0x100   /* Internal flag to say key
+                                       is Newx()ed. */
+#define HVhek_PLACEHOLD     0x200   /* Internal flag to create placeholder.
+                                     * (may change, but Storable is a core
+                                     * module) */
 #define HVhek_KEYCANONICAL  0x400   /* Internal flag - key is in canonical
-                                    form.  If the string is UTF-8, it
-                                    cannot be converted to bytes. */
+                                       form.  If the string is UTF-8, it
+                                       cannot be converted to bytes. */
 #define HVhek_ENABLEHVKFLAGS    (HVhek_UTF8|HVhek_WASUTF8)
 
 #define HEK_UTF8(hek)           (HEK_FLAGS(hek) & HVhek_UTF8)
@@ -624,7 +639,8 @@ instead of a string/length pair, and no precomputed hash.
 
 /* Flag bits are HVhek_UTF8, HVhek_WASUTF8, then */
 #define HVrhek_undef                  0x00  /* Value is undef. */
-#define HVrhek_delete                 0x10  /* Value is placeholder - signifies delete. */
+#define HVrhek_delete                 0x10  /* Value is placeholder -
+                                               signifies delete. */
 #define HVrhek_IV                     0x20  /* Value is IV. */
 #define HVrhek_UV                     0x30  /* Value is UV. */
 #define HVrhek_PV                     0x40  /* Value is a (byte) string. */