Centralize and document TRACE tags using X-macros (#7657)

* Introduce X-macro-based trace tag definition
- Created trace_tags.def to centralize TRACE tag definitions
- Each tag includes a symbolic name and description
- Set up enum class TraceTag for type-safe usage in TRACE macros

* Add script to generate Markdown documentation from trace_tags.def
- Python script parses trace_tags.def and outputs trace_tags.md

* Refactor TRACE_NEW to prepend TraceTag and pass enum to is_trace_enabled

* trace: improve trace tag handling system with hierarchical tagging

- Introduce hierarchical tag-class structure: enabling a tag class activates all child tags
- Unify TRACE, STRACE, SCTRACE, and CTRACE under enum TraceTag
- Implement initial version of trace_tag.def using X(tag, tag_class, description)
  (class names and descriptions to be refined in a future update)

* trace: replace all string-based TRACE tags with enum TraceTag
- Migrated all TRACE, STRACE, SCTRACE, and CTRACE macros to use enum TraceTag values instead of raw string literals

* trace : add cstring header

* trace : Add Markdown documentation generation from trace_tags.def via mk_api_doc.py

* trace : rename macro parameter 'class' to 'tag_class' and remove Unicode comment in trace_tags.h.

* trace : Add TODO comment for future implementation of tag_class activation

* trace : Disable code related to tag_class until implementation is ready (#7663).

src/sat/sat_bcd.cpp

@@ -44,7 +44,7 @@ namespace sat {
         report(bcd& f):f(f) {}
         ~report() {
             IF_VERBOSE(1, verbose_stream() << "Decomposed set " << f.m_L.size() << " rest: " << f.m_R.size() << "\n";);
-            TRACE("sat",
+            TRACE(sat,
                   tout << "Decomposed set " << f.m_L.size() << "\n";
                   for (bclause b : f.m_L) tout << b.lit << ": " << *b.cls << "\n";
                   tout << "Remainder " << f.m_R.size() << "\n";
@@ -90,7 +90,7 @@ namespace sat {
             m_bin_clauses.push_back(cls);
             register_clause(cls);
         }
-        TRACE("sat", for (clause* cls : m_clauses) if (cls) tout << *cls << "\n";);
+        TRACE(sat, for (clause* cls : m_clauses) if (cls) tout << *cls << "\n";);
     }
 
     void bcd::register_clause(clause* cls) {
@@ -128,7 +128,7 @@ namespace sat {
         }
         m_L.append(tmpL);
         m_R.append(tmpR);
-        TRACE("bcd", tout << lit << " " << "pos: " << tmpL.size() << " " << "neg: " << tmpR.size() << "\n";);
+        TRACE(bcd, tout << lit << " " << "pos: " << tmpL.size() << " " << "neg: " << tmpR.size() << "\n";);
     }
     
     void bcd::pure_decompose(use_list& ul, literal lit, svector<bclause>& clauses) {
@@ -239,7 +239,7 @@ namespace sat {
     }
 
     literal bcd::find_blocked(use_list& ul, clause const& cls) {
-        TRACE("bcd", tout << cls << "\n";);
+        TRACE(bcd, tout << cls << "\n";);
 
         for (literal lit : cls) {            
             m_marked[(~lit).index()] = true;
@@ -247,7 +247,7 @@ namespace sat {
         literal result = null_literal;
         for (literal lit : cls) {
             if (is_blocked(ul, lit)) {
-                TRACE("bcd", tout << "is blocked " << lit << " : " << cls << "\n";);
+                TRACE(bcd, tout << "is blocked " << lit << " : " << cls << "\n";);
                 result = lit;
                 break;
             }
@@ -342,7 +342,7 @@ namespace sat {
             }
         }
         IF_VERBOSE(0, verbose_stream() << "num merge: " << num_merge << "\n");
-        TRACE("sat", uf.display(tout););
+        TRACE(sat, uf.display(tout););
     }
 
     void bcd::cleanup() {