FROM ubuntu:24.04

# Install system requirements.
RUN <<EOF
    set -ex

    apt update
    
    apt --yes --no-install-recommends install gcc g++ python3 cmake make git flex bison ca-certificates
EOF

# Install custom Doxygen version from GitHub.
ARG DOXYGEN_VERSION=1.13.2

RUN <<EOF
    git clone --depth=1 --branch Release_$(echo ${DOXYGEN_VERSION} | tr . _) https://github.com/doxygen/doxygen doxygen

    cd doxygen

    cmake -S . -B build -DCMAKE_INSTALL_PREFIX=/opt/doxygen-${DOXYGEN_VERSION}

    cmake --build build -j4 --target install
EOF

ENV Doxygen_ROOT=/opt/doxygen-${DOXYGEN_VERSION}

# This is the problematic file.
COPY <<EOF generate-invalid-tag-file/MyLibrary.hpp
    #ifndef MYLIBRARY_HPP
    #define MYLIBRARY_HPP

    #include <iostream>
    #include <memory>

    namespace mylib
    {
        //! Default implementation of a helper @c struct.
        template <typename T>
        struct MyHelper
        {
            //! Say hello to your developer.
            void say_hello(const T value) const {
                printf("Default %s %f\\n", __PRETTY_FUNCTION__, value);
            }
        };

        //! Specialization for @c int.
        template <>
        struct MyHelper<int>
        {
            //! Deletor for @ref member.
            struct Deletor
            {
                //! This is some documentation.
                void operator()(const int*) const {}
            };

            void say_hello(const int value) const {
                printf("Specialized %s %d\\n", __PRETTY_FUNCTION__, value);
            }

            using impl_event_t    = int;
            using event_storage_t = std::unique_ptr<impl_event_t, Deletor>;

            event_storage_t member; //!< Member documentation.
        };

        //! This class call operator interfers with the above.
        struct Other
        {
            template <typename T>
            void operator()(const T&) const {
                printf("%s\\n", __PRETTY_FUNCTION__);
            }
        };

        //! This class call operator also interfers with the above.
        struct YetAnOther
        {
            template <typename T>
            void operator()(const T&) const {
                printf("%s\\n", __PRETTY_FUNCTION__);
            }
        };

    } // namespace mylib

    #endif // MYLIBRARY_HPP
EOF

# A simple test to check it's valid C++.
COPY <<EOF generate-invalid-tag-file/test_mylib.cpp
    #include "MyLibrary.hpp"

    int main()
    {
        mylib::MyHelper<int   >{}.say_hello(42);
        mylib::MyHelper<double>{}.say_hello(42.);
        mylib::Other           {}.operator()<char>(char(42));
    }
EOF

# This is a project that will generate an invalid tag file.
COPY <<EOF generate-invalid-tag-file/CMakeLists.txt
    cmake_minimum_required(VERSION 3.25)

    project(GenerateInvalidTagFile LANGUAGES CXX)

    add_executable(test)
    target_sources(test PRIVATE test_mylib.cpp)

    find_package(Doxygen ${DOXYGEN_VERSION} REQUIRED)

    set(DOXYGEN_EXTRACT_ALL YES)
    set(DOXYGEN_WARN_AS_ERROR YES)
    set(DOXYGEN_WARN_IF_UNDOCUMENTED NO)
    set(DOXYGEN_GENERATE_TAGFILE "$\{CMAKE_SOURCE_DIR\}/invalid-tag-file.tag")
    doxygen_add_docs(docs MyLibrary.hpp)
EOF

RUN <<EOF
    set -ex

    cd generate-invalid-tag-file

    cmake -S . -B build

    cmake --build build --target=test

    ./build/test

    cmake --build build --target=docs

    test -f invalid-tag-file.tag
EOF

# This is a project that will try to consume the invalid tag file.
COPY <<EOF consume-invalid-tag-file/test_empty.hpp
//! This does not matter.
void empty();
EOF

COPY <<EOF consume-invalid-tag-file/CMakeLists.txt
    cmake_minimum_required(VERSION 3.25)

    project(ConsumeInvalidTagFile LANGUAGES CXX)

    find_package(Doxygen ${DOXYGEN_VERSION} REQUIRED)

    set(DOXYGEN_EXTRACT_ALL YES)
    set(DOXYGEN_WARN_AS_ERROR YES)
    set(DOXYGEN_WARN_IF_UNDOCUMENTED NO)
    set(DOXYGEN_TAGFILES "/generate-invalid-tag-file/invalid-tag-file.tag")
    if(NOT EXISTS $\{DOXYGEN_TAGFILES\})
        message(FATAL_ERROR "The tag file $\{DOXYGEN_TAGFILES\} path is not valid.")
    endif()

    doxygen_add_docs(docs test_empty.hpp)
EOF

RUN <<EOF
    set -ex

    cd consume-invalid-tag-file

    cmake -S . -B build

    cmake --build build --target=docs
EOF