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/ast/proofs/proof_checker.cpp

@@ -301,7 +301,7 @@ bool proof_checker::check1_basic(proof* p, expr_ref_vector& side_conditions) {
         return false;
     }
     case PR_MONOTONICITY: {
-        TRACE("proof_checker", tout << mk_bounded_pp(p, m, 3) << "\n";);
+        TRACE(proof_checker, tout << mk_bounded_pp(p, m, 3) << "\n";);
         if (match_fact(p, fact) &&
             match_binary(fact, d1, t1, t2) &&
             match_app(t1, f1, terms1) &&
@@ -530,7 +530,7 @@ bool proof_checker::check1_basic(proof* p, expr_ref_vector& side_conditions) {
                     found = match_negated(ors[j].get(), hypotheses[i].get());
                 }
                 if (!found) {
-                    TRACE("pr_lemma_bug",
+                    TRACE(pr_lemma_bug,
                           tout << "i: " << i << "\n";
                           tout << "ORs:\n" << ors << "\n";
                           tout << "HYPOTHESIS:\n" << hypotheses << "\n";
@@ -538,7 +538,7 @@ bool proof_checker::check1_basic(proof* p, expr_ref_vector& side_conditions) {
                     UNREACHABLE();
                     return false;
                 }
-                TRACE("proof_checker", tout << "Matched:\n";
+                TRACE(proof_checker, tout << "Matched:\n";
                       ast_ll_pp(tout, m, hypotheses[i].get());
                       ast_ll_pp(tout, m, ors[j-1].get()););
             }
@@ -575,7 +575,7 @@ bool proof_checker::check1_basic(proof* p, expr_ref_vector& side_conditions) {
                     }
                 }
                 if (!found) {
-                    TRACE("pr_unit_bug",
+                    TRACE(pr_unit_bug,
                           tout << "Parents:\n";
                           for (unsigned i = 0; i < proofs.size(); i++) {
                               expr* p = nullptr;
@@ -791,7 +791,7 @@ bool proof_checker::check1_basic(proof* p, expr_ref_vector& side_conditions) {
                 premise = vs(premise, sub.size(), sub.data());
             }
             fmls.push_back(premise.get());
-            TRACE("proof_checker",
+            TRACE(proof_checker,
                   tout << mk_pp(premise.get(), m) << "\n";
                   for (unsigned j = 0; j < sub.size(); ++j) {
                       tout << mk_pp(sub[j], m) << " ";
@@ -1151,7 +1151,7 @@ void proof_checker::get_hypotheses(proof* p, expr_ref_vector& ante) {
             SASSERT(match_nil(h));
         }
     }
-    TRACE("proof_checker",
+    TRACE(proof_checker,
           {
               ast_ll_pp(tout << "Getting hypotheses from: ", m, p);
               tout << "Found hypotheses:\n";
@@ -1396,7 +1396,7 @@ bool proof_checker::check_arith_proof(proof* p) {
             return false;
         }
     }
-    TRACE("proof_checker", 
+    TRACE(proof_checker, 
           for (unsigned i = 0; i < num_parents; i++) 
               tout << coeffs[i] << " * " << mk_bounded_pp(m.get_fact(m.get_parent(p, i)), m) << "\n";
           tout << "fact:" << mk_bounded_pp(fact, m) << "\n";);

src/ast/proofs/proof_utils.cpp

@@ -469,7 +469,7 @@ public:
         tmp = pr;
         elim(pr);
         reset();
-        CTRACE("proof_utils", contains_hypothesis(pr),
+        CTRACE(proof_utils, contains_hypothesis(pr),
             tout << "Contains hypothesis:\n";
             tout << mk_ismt2_pp(tmp, m) << "\n====>\n";
             tout << mk_ismt2_pp(pr, m) << "\n";);
@@ -569,7 +569,7 @@ public:
             m_hypmap.insert(result, new_hyps);
             // might push 0 into m_hyprefs. No reason for that
             m_hyprefs.push_back(new_hyps);
-            TRACE("proof_utils",            
+            TRACE(proof_utils,            
                     tout << "New lemma: " << mk_pp(m.get_fact(p), m) 
                       << "\n==>\n" 
                       << mk_pp(m.get_fact(result), m) << "\n";
@@ -743,7 +743,7 @@ void proof_utils::reduce_hypotheses(proof_ref& pr) {
     ast_manager& m = pr.get_manager();
     class reduce_hypotheses0 reduce(m);
     reduce(pr);
-    CTRACE("proof_utils", !is_closed(m, pr), tout << mk_pp(pr, m) << "\n";);
+    CTRACE(proof_utils, !is_closed(m, pr), tout << mk_pp(pr, m) << "\n";);
 }
 
 class proof_is_closed {
@@ -985,7 +985,7 @@ private:
         }
         quantifier* q = to_quantifier(fml);
         if (q->get_num_decls() != sub.size()) {
-            TRACE("proof_utils", tout << "quantifier has different number of variables than substitution";
+            TRACE(proof_utils, tout << "quantifier has different number of variables than substitution";
                   tout << mk_pp(q, m) << "\n";
                   tout << sub.size() << "\n";);
             return;

src/ast/proofs/proof_utils.h

@@ -221,7 +221,7 @@ public:
             }
             cache.insert(p, newp);
             todo.pop_back();
-            CTRACE("virtual",
+            CTRACE(proof_virtual,
                    p->get_decl_kind() == PR_TH_LEMMA &&
                    p->get_decl()->get_parameter(0).get_symbol() == "arith" &&
                    p->get_decl()->get_num_parameters() > 1 &&