regcomp.h: Add comments
authorKarl Williamson <khw@cpan.org>
Sun, 22 Sep 2019 21:26:03 +0000 (15:26 -0600)
committerKarl Williamson <khw@cpan.org>
Sun, 29 Sep 2019 17:46:25 +0000 (11:46 -0600)
regcomp.h

index d756026..9bdd945 100644 (file)
--- a/regcomp.h
+++ b/regcomp.h
@@ -334,8 +334,15 @@ struct regnode_ssc {
 
 #define        STR_LEN(p)      (((struct regnode_string *)p)->str_len)
 #define        STRING(p)       (((struct regnode_string *)p)->string)
+
+/* The number of (smallest) regnode equivalents that a string of length l bytes
+ * occupies */
 #define STR_SZ(l)      (((l) + sizeof(regnode) - 1) / sizeof(regnode))
+
+/* The number of (smallest) regnode equivalents that the EXACTISH node 'p'
+ * occupies */
 #define NODE_SZ_STR(p) (STR_SZ(STR_LEN(p))+1)
+
 #define setSTR_LEN(p,v)                                                     \
             ((struct regnode_string *)(p))->str_len = (v);
 
@@ -716,6 +723,8 @@ struct regnode_ssc {
 #  define UCHARAT(p)   ((int)*(p)&CHARMASK)
 #endif
 
+/* Number of regnode equivalents that 'guy' occupies beyond the size of the
+ * smallest regnode. */
 #define EXTRA_SIZE(guy) ((sizeof(guy)-1)/sizeof(struct regnode))
 
 #define REG_ZERO_LEN_SEEN                   0x00000001