3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-06-28 08:58:44 +00:00

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).
This commit is contained in:
LeeYoungJoon 2025-05-28 22:31:25 +09:00 committed by GitHub
parent d766292dab
commit 0a93ff515d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
583 changed files with 8698 additions and 7299 deletions

View file

@ -38,7 +38,7 @@ namespace smt {
for (; it != end; ++it) {
symbol const & s = *it;
if (s.contains('@')) {
TRACE("for_each_relevant_expr", tout << "@ label: " << mk_pp(n, m_manager) << "\n";);
TRACE(for_each_relevant_expr, tout << "@ label: " << mk_pp(n, m_manager) << "\n";);
count += 1;
}
}
@ -74,7 +74,7 @@ namespace smt {
}
if (count > 1 && m_first) {
TRACE("for_each_relevant_expr", tout << mk_pp(n, m_manager) << "\n";);
TRACE(for_each_relevant_expr, tout << mk_pp(n, m_manager) << "\n";);
m_first = false;
}
@ -108,7 +108,7 @@ namespace smt {
}
if (count > 1 && m_first) {
TRACE("for_each_relevant_expr", tout << mk_pp(n, m_manager) << "\n";);
TRACE(for_each_relevant_expr, tout << mk_pp(n, m_manager) << "\n";);
m_first = false;
}
@ -121,7 +121,7 @@ namespace smt {
}
void for_each_relevant_expr::operator()(expr * n) {
TRACE("for_each_relevant_expr", tout << "#" << n->get_id() << "\n";);
TRACE(for_each_relevant_expr, tout << "#" << n->get_id() << "\n";);
}
void for_each_relevant_expr::reset() {
@ -140,8 +140,8 @@ namespace smt {
}
void for_each_relevant_expr::process(expr * n) {
TRACE("for_each_relevant_expr", tout << "processing:\n" << mk_bounded_pp(n, m_manager) << "\n";);
TRACE("for_each_relevant_expr", tout << "processing:\n" << mk_pp(n, m_manager) << "\n";);
TRACE(for_each_relevant_expr, tout << "processing:\n" << mk_bounded_pp(n, m_manager) << "\n";);
TRACE(for_each_relevant_expr, tout << "processing:\n" << mk_pp(n, m_manager) << "\n";);
if (m_cache.contains(n))
return;
m_todo.reset();
@ -196,7 +196,7 @@ namespace smt {
*/
void for_each_relevant_expr::process_relevant_child(app * n, lbool val) {
unsigned sz = n->get_num_args();
TRACE("for_each_relevant_expr", tout << val << " " << mk_bounded_pp(n, m_manager) << "\n";);
TRACE(for_each_relevant_expr, tout << val << " " << mk_bounded_pp(n, m_manager) << "\n";);
for (unsigned i = 0; i < sz; i++) {
expr * arg = n->get_arg(i);
if (!is_relevant(arg))
@ -204,7 +204,7 @@ namespace smt {
if (get_assignment(arg) != val)
continue;
if (m_cache.contains(arg)) {
TRACE("for_each_relevant_expr", tout << "justified by: " << mk_bounded_pp(arg, m_manager) << "\n";);
TRACE(for_each_relevant_expr, tout << "justified by: " << mk_bounded_pp(arg, m_manager) << "\n";);
return; // the current child justifies n.
}
}
@ -215,7 +215,7 @@ namespace smt {
if (get_assignment(arg) != val)
continue;
TRACE("for_each_relevant_expr", tout << "to_process: " << mk_bounded_pp(arg, m_manager) << "\n";);
TRACE(for_each_relevant_expr, tout << "to_process: " << mk_bounded_pp(arg, m_manager) << "\n";);
m_todo.push_back(arg);
return;
@ -271,7 +271,7 @@ namespace smt {
void collect_relevant_label_lits::operator()(expr * n) {
TRACE("for_each_relevant_expr",
TRACE(for_each_relevant_expr,
tout << "label: " << m_manager.is_label_lit(n) << " " << " " << get_assignment(n)
<< " " << mk_bounded_pp(n, m_manager) << "\n";);
if (!m_manager.is_label_lit(n))
@ -283,7 +283,7 @@ namespace smt {
void collect_relevant_labels::operator()(expr * n) {
bool pos;
TRACE("for_each_relevant_expr",
TRACE(for_each_relevant_expr,
tout << "label: " << m_manager.is_label(n) << " " << get_assignment(n)
<< " " << mk_bounded_pp(n, m_manager) << "\n";);
if (!m_manager.is_label(n, pos))