dev: remove the DEBUG macro

flavorjones · flavorjones · commit afc6e949bb21 · 2022-10-16T09:46:42.000-04:00
I haven't used it in years, TBH, and what it does is completely
insufficient to debug memory issues in modern Ruby anyway.
diff --git a/ext/nokogiri/html4_sax_parser_context.c b/ext/nokogiri/html4_sax_parser_context.c
@@ -5,13 +5,8 @@ VALUE cNokogiriHtml4SaxParserContext ;
 static void
 deallocate(xmlParserCtxtPtr ctxt)
 {
-  NOKOGIRI_DEBUG_START(ctxt);
-
   ctxt->sax = NULL;
-
   htmlFreeParserCtxt(ctxt);
-
-  NOKOGIRI_DEBUG_END(ctxt);
 }
 
 static VALUE
diff --git a/ext/nokogiri/nokogiri.h b/ext/nokogiri/nokogiri.h
@@ -75,14 +75,6 @@ xmlNodePtr xmlLastElementChild(xmlNodePtr parent);
 #define NOKOGIRI_STR_NEW(str, len) rb_external_str_new_with_enc((const char *)(str), (long)(len), rb_utf8_encoding())
 #define RBSTR_OR_QNIL(_str) (_str ? NOKOGIRI_STR_NEW2(_str) : Qnil)
 
-#ifdef DEBUG
-#  define NOKOGIRI_DEBUG_START(p) if (getenv("NOKOGIRI_NO_FREE")) return ; if (getenv("NOKOGIRI_DEBUG")) fprintf(stderr,"nokogiri: %s:%d %p start\n", __FILE__, __LINE__, p);
-#  define NOKOGIRI_DEBUG_END(p) if (getenv("NOKOGIRI_DEBUG")) fprintf(stderr,"nokogiri: %s:%d %p end\n", __FILE__, __LINE__, p);
-#else
-#  define NOKOGIRI_DEBUG_START(p)
-#  define NOKOGIRI_DEBUG_END(p)
-#endif
-
 #ifndef NORETURN_DECL
 #  if defined(__GNUC__)
 #    define NORETURN_DECL __attribute__ ((noreturn))
diff --git a/ext/nokogiri/xml_document.c b/ext/nokogiri/xml_document.c
@@ -65,8 +65,6 @@ dealloc(xmlDocPtr doc)
 {
   st_table *node_hash;
 
-  NOKOGIRI_DEBUG_START(doc);
-
   node_hash  = DOC_UNLINKED_NODE_HASH(doc);
 
   st_foreach(node_hash, dealloc_node_i, (st_data_t)doc);
@@ -84,8 +82,6 @@ dealloc(xmlDocPtr doc)
   }
 
   xmlFreeDoc(doc);
-
-  NOKOGIRI_DEBUG_END(doc);
 }
 
 static void
diff --git a/ext/nokogiri/xml_namespace.c b/ext/nokogiri/xml_namespace.c
@@ -31,15 +31,13 @@ dealloc_namespace(xmlNsPtr ns)
    * this deallocator is only used for namespace nodes that are part of an xpath
    * node set. see noko_xml_namespace_wrap().
    */
-  NOKOGIRI_DEBUG_START(ns) ;
   if (ns->href) {
     xmlFree(DISCARD_CONST_QUAL_XMLCHAR(ns->href));
   }
   if (ns->prefix) {
     xmlFree(DISCARD_CONST_QUAL_XMLCHAR(ns->prefix));
   }
   xmlFree(ns);
-  NOKOGIRI_DEBUG_END(ns) ;
 }
 
 
diff --git a/ext/nokogiri/xml_node.c b/ext/nokogiri/xml_node.c
@@ -9,16 +9,7 @@ static ID id_decorate, id_decorate_bang;
 
 typedef xmlNodePtr(*pivot_reparentee_func)(xmlNodePtr, xmlNodePtr);
 
-#ifdef DEBUG
-static void
-_xml_node_dealloc(xmlNodePtr x)
-{
-  NOKOGIRI_DEBUG_START(x)
-  NOKOGIRI_DEBUG_END(x)
-}
-#else
-#  define _xml_node_dealloc 0
-#endif
+#define _xml_node_dealloc 0
 
 static void
 _xml_node_mark(xmlNodePtr node)
diff --git a/ext/nokogiri/xml_node_set.c b/ext/nokogiri/xml_node_set.c
@@ -88,13 +88,11 @@ deallocate(xmlNodeSetPtr node_set)
    * For reasons outlined in xml_namespace.c, here we reproduce xmlXPathFreeNodeSet() except for the
    * offending call to xmlXPathNodeSetFreeNs().
    */
-  NOKOGIRI_DEBUG_START(node_set) ;
   if (node_set->nodeTab != NULL) {
     xmlFree(node_set->nodeTab);
   }
 
   xmlFree(node_set);
-  NOKOGIRI_DEBUG_END(node_set) ;
 }
 
 
diff --git a/ext/nokogiri/xml_reader.c b/ext/nokogiri/xml_reader.c
@@ -5,9 +5,7 @@ VALUE cNokogiriXmlReader;
 static void
 dealloc(xmlTextReaderPtr reader)
 {
-  NOKOGIRI_DEBUG_START(reader);
   xmlFreeTextReader(reader);
-  NOKOGIRI_DEBUG_END(reader);
 }
 
 static int
diff --git a/ext/nokogiri/xml_relax_ng.c b/ext/nokogiri/xml_relax_ng.c
@@ -5,9 +5,7 @@ VALUE cNokogiriXmlRelaxNG;
 static void
 dealloc(xmlRelaxNGPtr schema)
 {
-  NOKOGIRI_DEBUG_START(schema);
   xmlRelaxNGFree(schema);
-  NOKOGIRI_DEBUG_END(schema);
 }
 
 /*
diff --git a/ext/nokogiri/xml_sax_parser.c b/ext/nokogiri/xml_sax_parser.c
@@ -268,9 +268,7 @@ processing_instruction(void *ctx, const xmlChar *name, const xmlChar *content)
 static void
 deallocate(xmlSAXHandlerPtr handler)
 {
-  NOKOGIRI_DEBUG_START(handler);
   ruby_xfree(handler);
-  NOKOGIRI_DEBUG_END(handler);
 }
 
 static VALUE
diff --git a/ext/nokogiri/xml_sax_parser_context.c b/ext/nokogiri/xml_sax_parser_context.c
@@ -7,13 +7,8 @@ static ID id_read;
 static void
 deallocate(xmlParserCtxtPtr ctxt)
 {
-  NOKOGIRI_DEBUG_START(ctxt);
-
   ctxt->sax = NULL;
-
   xmlFreeParserCtxt(ctxt);
-
-  NOKOGIRI_DEBUG_END(ctxt);
 }
 
 /*
diff --git a/ext/nokogiri/xml_sax_push_parser.c b/ext/nokogiri/xml_sax_push_parser.c
@@ -5,12 +5,10 @@ VALUE cNokogiriXmlSaxPushParser ;
 static void
 deallocate(xmlParserCtxtPtr ctx)
 {
-  NOKOGIRI_DEBUG_START(ctx);
   if (ctx != NULL) {
     NOKOGIRI_SAX_TUPLE_DESTROY(ctx->userData);
     xmlFreeParserCtxt(ctx);
   }
-  NOKOGIRI_DEBUG_END(ctx);
 }
 
 static VALUE
diff --git a/ext/nokogiri/xml_schema.c b/ext/nokogiri/xml_schema.c
@@ -5,9 +5,7 @@ VALUE cNokogiriXmlSchema;
 static void
 dealloc(xmlSchemaPtr schema)
 {
-  NOKOGIRI_DEBUG_START(schema);
   xmlSchemaFree(schema);
-  NOKOGIRI_DEBUG_END(schema);
 }
 
 /*
diff --git a/ext/nokogiri/xml_xpath_context.c b/ext/nokogiri/xml_xpath_context.c
@@ -14,9 +14,7 @@ static const xmlChar *NOKOGIRI_BUILTIN_URI = (const xmlChar *)"https://www.nokog
 static void
 xml_xpath_context_deallocate(xmlXPathContextPtr ctx)
 {
-  NOKOGIRI_DEBUG_START(ctx);
   xmlXPathFreeContext(ctx);
-  NOKOGIRI_DEBUG_END(ctx);
 }
 
 /* find a CSS class in an HTML element's `class` attribute */
diff --git a/ext/nokogiri/xslt_stylesheet.c b/ext/nokogiri/xslt_stylesheet.c
@@ -12,11 +12,7 @@ static void
 dealloc(nokogiriXsltStylesheetTuple *wrapper)
 {
   xsltStylesheetPtr doc = wrapper->ss;
-
-  NOKOGIRI_DEBUG_START(doc);
-  xsltFreeStylesheet(doc); /* commented out for now. */
-  NOKOGIRI_DEBUG_END(doc);
-
+  xsltFreeStylesheet(doc);
   ruby_xfree(wrapper);
 }
 
diff --git a/rakelib/debug.rake b/rakelib/debug.rake
@@ -1,12 +1,5 @@
 # frozen_string_literal: true
 
-desc "Set environment variables to build and/or test with debug options"
-task :debug do
-  ENV["NOKOGIRI_DEBUG"] = "true"
-  ENV["CFLAGS"] ||= ""
-  ENV["CFLAGS"] += " -DDEBUG"
-end
-
 task :java_debug do # rubocop:disable Rake/Desc
   ENV["JRUBY_OPTS"] = "#{ENV["JRUBY_OPTS"]} --debug --dev"
   if ENV["JAVA_DEBUG"]

Original file line number	Diff line number	Diff line change
`@@ -5,13 +5,8 @@ VALUE cNokogiriHtml4SaxParserContext ;`
`5`	`5`	`static void`
`6`	`6`	`deallocate(xmlParserCtxtPtr ctxt)`
`7`	`7`	`{`
`8`		`- NOKOGIRI_DEBUG_START(ctxt);`
`9`		`-`
`10`	`8`	`ctxt->sax = NULL;`
`11`		`-`
`12`	`9`	`htmlFreeParserCtxt(ctxt);`
`13`		`-`
`14`		`- NOKOGIRI_DEBUG_END(ctxt);`
`15`	`10`	`}`
`16`	`11`
`17`	`12`	`static VALUE`
Original file line number	Diff line number	Diff line change
`@@ -65,8 +65,6 @@ dealloc(xmlDocPtr doc)`
`65`	`65`	`{`
`66`	`66`	`st_table *node_hash;`
`67`	`67`
`68`		`- NOKOGIRI_DEBUG_START(doc);`
`69`		`-`
`70`	`68`	`node_hash = DOC_UNLINKED_NODE_HASH(doc);`
`71`	`69`
`72`	`70`	`st_foreach(node_hash, dealloc_node_i, (st_data_t)doc);`
`@@ -84,8 +82,6 @@ dealloc(xmlDocPtr doc)`
`84`	`82`	`}`
`85`	`83`
`86`	`84`	`xmlFreeDoc(doc);`
`87`		`-`
`88`		`- NOKOGIRI_DEBUG_END(doc);`
`89`	`85`	`}`
`90`	`86`
`91`	`87`	`static void`
Original file line number	Diff line number	Diff line change
`@@ -31,15 +31,13 @@ dealloc_namespace(xmlNsPtr ns)`
`31`	`31`	`* this deallocator is only used for namespace nodes that are part of an xpath`
`32`	`32`	`* node set. see noko_xml_namespace_wrap().`
`33`	`33`	`*/`
`34`		`- NOKOGIRI_DEBUG_START(ns) ;`
`35`	`34`	`if (ns->href) {`
`36`	`35`	`xmlFree(DISCARD_CONST_QUAL_XMLCHAR(ns->href));`
`37`	`36`	`}`
`38`	`37`	`if (ns->prefix) {`
`39`	`38`	`xmlFree(DISCARD_CONST_QUAL_XMLCHAR(ns->prefix));`
`40`	`39`	`}`
`41`	`40`	`xmlFree(ns);`
`42`		`- NOKOGIRI_DEBUG_END(ns) ;`
`43`	`41`	`}`
`44`	`42`
`45`	`43`
Original file line number	Diff line number	Diff line change
`@@ -88,13 +88,11 @@ deallocate(xmlNodeSetPtr node_set)`
`88`	`88`	`* For reasons outlined in xml_namespace.c, here we reproduce xmlXPathFreeNodeSet() except for the`
`89`	`89`	`* offending call to xmlXPathNodeSetFreeNs().`
`90`	`90`	`*/`
`91`		`- NOKOGIRI_DEBUG_START(node_set) ;`
`92`	`91`	`if (node_set->nodeTab != NULL) {`
`93`	`92`	`xmlFree(node_set->nodeTab);`
`94`	`93`	`}`
`95`	`94`
`96`	`95`	`xmlFree(node_set);`
`97`		`- NOKOGIRI_DEBUG_END(node_set) ;`
`98`	`96`	`}`
`99`	`97`
`100`	`98`
Original file line number	Diff line number	Diff line change
`@@ -5,9 +5,7 @@ VALUE cNokogiriXmlReader;`
`5`	`5`	`static void`
`6`	`6`	`dealloc(xmlTextReaderPtr reader)`
`7`	`7`	`{`
`8`		`- NOKOGIRI_DEBUG_START(reader);`
`9`	`8`	`xmlFreeTextReader(reader);`
`10`		`- NOKOGIRI_DEBUG_END(reader);`
`11`	`9`	`}`
`12`	`10`
`13`	`11`	`static int`
Original file line number	Diff line number	Diff line change
`@@ -5,9 +5,7 @@ VALUE cNokogiriXmlRelaxNG;`
`5`	`5`	`static void`
`6`	`6`	`dealloc(xmlRelaxNGPtr schema)`
`7`	`7`	`{`
`8`		`- NOKOGIRI_DEBUG_START(schema);`
`9`	`8`	`xmlRelaxNGFree(schema);`
`10`		`- NOKOGIRI_DEBUG_END(schema);`
`11`	`9`	`}`
`12`	`10`
`13`	`11`	`/*`
Original file line number	Diff line number	Diff line change
`@@ -268,9 +268,7 @@ processing_instruction(void ctx, const xmlChar name, const xmlChar *content)`
`268`	`268`	`static void`
`269`	`269`	`deallocate(xmlSAXHandlerPtr handler)`
`270`	`270`	`{`
`271`		`- NOKOGIRI_DEBUG_START(handler);`
`272`	`271`	`ruby_xfree(handler);`
`273`		`- NOKOGIRI_DEBUG_END(handler);`
`274`	`272`	`}`
`275`	`273`
`276`	`274`	`static VALUE`
Original file line number	Diff line number	Diff line change
`@@ -7,13 +7,8 @@ static ID id_read;`
`7`	`7`	`static void`
`8`	`8`	`deallocate(xmlParserCtxtPtr ctxt)`
`9`	`9`	`{`
`10`		`- NOKOGIRI_DEBUG_START(ctxt);`
`11`		`-`
`12`	`10`	`ctxt->sax = NULL;`
`13`		`-`
`14`	`11`	`xmlFreeParserCtxt(ctxt);`
`15`		`-`
`16`		`- NOKOGIRI_DEBUG_END(ctxt);`
`17`	`12`	`}`
`18`	`13`
`19`	`14`	`/*`