more format work, debug heap checking (msvc)

Author: vinniefalco

CMakeLists.txt

@@ -41,7 +41,6 @@ endif()
 
 if (WIN32)
     add_definitions(
-        -D_WIN32_WINNT=0x0601
         -D_CRT_SECURE_NO_WARNINGS
         -D_SILENCE_CXX20_CISO646_REMOVED_WARNING)
     if("${CMAKE_GENERATOR_PLATFORM}" STREQUAL "Win32") # 32-bit

include/mrdox/Debug.hpp

@@ -0,0 +1,36 @@
+//
+// Licensed under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+// Copyright (c) 2023 Vinnie Falco ([email protected])
+//
+// Official repository: https://github.com/cppalliance/mrdox
+//
+
+#ifndef MRDOX_DEBUG_HPP
+#define MRDOX_DEBUG_HPP
+
+// Some nice odds and ends such as leak checking
+// and redirection to the Visual Studio output window.
+
+namespace clang {
+namespace mrdox {
+
+/** Enable output window redirection for standard streams.
+
+    This will only take effect if a debugger
+    is attached at the time of the call.
+*/
+void
+debugEnableRedirecton();
+
+/** Enable debug heap checking.
+*/
+void
+debugEnableHeapChecking();
+
+} // mrdox
+} // clang
+
+#endif

source/lib/Debug.cpp

@@ -0,0 +1,106 @@
+//
+// Licensed under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+// Copyright (c) 2023 Vinnie Falco ([email protected])
+//
+// Official repository: https://github.com/cppalliance/mrdox
+//
+
+#include <mrdox/Debug.hpp>
+
+#if defined(_MSC_VER) && ! defined(NDEBUG)
+
+#include <iostream>
+#include <sstream>
+
+#define WIN32_LEAN_AND_MEAN
+#include <windows.h>
+
+namespace clang {
+namespace mrdox {
+
+namespace {
+
+class debug_streambuf
+    : public std::stringbuf
+{
+    std::ostream& os_;
+    bool dbg_;
+
+    void
+    write(char const* s)
+    {
+        if(dbg_)
+            ::OutputDebugStringA(s);
+        os_ << s;
+    }
+
+public:
+    explicit
+    debug_streambuf(
+        std::ostream& os)
+        : os_(os)
+        , dbg_(::IsDebuggerPresent() != 0)
+    {
+    }
+
+    ~debug_streambuf()
+    {
+        sync();
+    }
+
+    int sync() override
+    {
+        write(this->str().c_str());
+        this->str("");
+        return 0;
+    }
+};
+
+} // (anon)
+
+void
+debugEnableRedirecton()
+{
+    static debug_streambuf out(std::cout);
+    static debug_streambuf err(std::cerr);
+
+    std::cout.rdbuf(&out);
+    std::cerr.rdbuf(&err);
+}
+
+void
+debugEnableHeapChecking()
+{
+#if defined(_MSC_VER) && ! defined(NDEBUG)
+    int flags = _CrtSetDbgFlag(
+        _CRTDBG_REPORT_FLAG);
+    flags |= _CRTDBG_LEAK_CHECK_DF;
+    _CrtSetDbgFlag(flags);
+#endif
+}
+
+} // mrdox
+} // clang
+
+#else
+
+//------------------------------------------------
+
+namespace clang {
+namespace mrdox {
+
+void debugEnableRedirecton()
+{
+}
+
+void debugEnableHeapChecking()
+{
+}
+
+} // mrdox
+} // clang
+
+#endif

source/lib/ast/ParseJavadoc.cpp

@@ -129,14 +129,13 @@ class JavadocVisitor
         return s;
     }
 
-    template<class T, class R, class... Args>
-    static void visit_children(
-        ConstCommentVisitor<T, R, Args...>* visitor,
+    template<class... Args>
+    void visitChildren(
         Comment const* C)
     {
         for(auto const* it = C->child_begin();
                 it != C->child_end(); ++it)
-            visitor->visit(*it);
+            visit(*it);
     }
 
 public:
@@ -163,29 +162,48 @@ class JavadocVisitor
     void visitComment(
         Comment const* C)
     {
-        visit_children(this, C);
+        visitChildren(C);
     }
 
     void visitTextComment(
         TextComment const* C)
     {
-        llvm::StringRef s;
+        llvm::StringRef s = C->getText();
         // If this is the very first node, the
         // paragraph has no doxygen command,
         // so we will trim the leading space.
         // Otherwise just trim trailing space
+#if 0
         if(para_->children.empty())
-            s = C->getText().ltrim().rtrim();
+            s = s.ltrim().rtrim();
         else
-            s = C->getText().rtrim();
-            //s = C->getText().ltrim().rtrim();
+            s = s.rtrim();
+            //s = s.ltrim().rtrim();
+#endif
 
         // VFALCO Figure out why we get empty TextComment
-        if(! s.empty())
+        //if(! s.empty())
             Javadoc::append(*para_,
                 Javadoc::Text(ensureUTF8(s.str())));
     }
 
+    void visitHTMLTagComment(
+        HTMLTagComment const* C)
+    {
+        visitChildren(C);
+    }
+
+    void visitHTMLStartTagComment(
+        HTMLStartTagComment const* C)
+    {
+        visitChildren(C);
+    }
+
+    void HTMLEndTagComment(
+        HTMLStartTagComment const* C)
+    {
+    }
+
     void visitInlineCommandComment(
         InlineCommandComment const* C)
     {
@@ -236,10 +254,10 @@ class JavadocVisitor
         ParagraphComment const* C)
     {
         if(para_)
-            return visit_children(this, C);
+            return visitChildren(C);
         Javadoc::Paragraph para;
         Scope scope(para, para_);
-        visit_children(this, C);
+        visitChildren(C);
         // VFALCO Figure out why we get empty ParagraphComment
         if(! para.empty())
             Javadoc::append(blocks_, std::move(para));
@@ -262,29 +280,29 @@ class JavadocVisitor
         {
             Javadoc::Brief brief;
             Scope scope(brief, para_);
-            visit_children(this, C->getParagraph());
+            visitChildren(C->getParagraph());
             Javadoc::append(blocks_, std::move(brief));
             return;
         }
         if(cmd->IsReturnsCommand)
         {
             Scope scope(returns_, para_);
-            visit_children(this, C->getParagraph());
+            visitChildren(C->getParagraph());
             return;
         }
         if(cmd->getID() == CommandTraits::KCI_note)
         {
             Javadoc::Admonition para(Javadoc::Admonish::note);
             Scope scope(para, para_);
-            visit_children(this, C->getParagraph());
+            visitChildren(C->getParagraph());
             Javadoc::append(blocks_, std::move(para));
             return;
         }
         if(cmd->getID() == CommandTraits::KCI_warning)
         {
             Javadoc::Admonition para(Javadoc::Admonish::warning);
             Scope scope(para, para_);
-            visit_children(this, C->getParagraph());
+            visitChildren(C->getParagraph());
             Javadoc::append(blocks_, std::move(para));
             return;
         }
@@ -301,7 +319,7 @@ class JavadocVisitor
             name = "@anon";
         Scope scope(para, para_);
         //if(C->hasNonWhitespaceParagraph())
-        visit_children(this, C->getParagraph());
+        visitChildren(C->getParagraph());
         params_.emplace_back(Javadoc::Param(
             std::move(name), std::move(para)));
     }
@@ -317,7 +335,7 @@ class JavadocVisitor
             name = "@anon";
         Scope scope(para, para_);
         //if(C->hasNonWhitespaceParagraph())
-        visit_children(this, C->getParagraph());
+        visitChildren(C->getParagraph());
         tparams_.emplace_back(Javadoc::TParam(
             std::move(name), std::move(para)));
     }
@@ -328,7 +346,7 @@ class JavadocVisitor
         Javadoc::Code code;
         Scope scope(code, code_);
         //if(C->hasNonWhitespaceParagraph())
-        visit_children(this, C);
+        visitChildren(C);
         Javadoc::append(blocks_, std::move(code));
     }