jobs.hpp

Go to the documentation of this file.

//==================================================================================================
/// \file
/// This header-file is part of \dxl - A doxygen post-processor that allows to define smarter
/// <b>Doxygen</b>-links.
///
/// \emoji :copyright: 2025-2026 A-Worx GmbH, Germany.
/// Published under \ref mainpage_license "Boost Software License".
//==================================================================================================
#ifndef HPP_DXL_JOB
#define HPP_DXL_JOB
#pragma once
#include "threadpool.hpp"
#include "ALib.ThreadModel.H"
#include "ALib.FileTree.H"
 
 
 
namespace dxl {
 
class  DoxygenXLinks;
class  Index;
 
/// This is a job executed by the #"ThreadPool" in class #"DoxygenXLinks".
/// The job loads an index file. Only external tag-file are loaded by the thread pool.
/// The main tag-file is loaded by the main thread.
struct IndexLoader : DXLJob  {
    /// The index to load.
    Index&              index;
 
    /// Constructor.
    /// @param pIndex The index to load.
    IndexLoader( Index& pIndex )
    : DXLJob(typeid(IndexLoader))
    , index(pIndex)                                                                               {}
 
    /// Overrides the parent function as necessary.
    /// @return The sizeof this derived type.
    size_t      SizeOf()                                    override { return sizeof(IndexLoader); }
 
    /// Implements this job.
    /// @return Constant \c true.
    bool        Do()                                                                       override;
};
 
/// This is a job executed by the #"ThreadPool" in class #"DoxygenXLinks".
/// The job loads an HTML file and searches for #"XLink"s and replaces them with an
/// HTML anchor.
struct HTMLReplacer : DXLJob  {
    /// The main linker class.
    DoxygenXLinks&      dxl;
 
    /// The HTML-file to load and search for \dxl links.
    alib::filetree::FTFile   htmlFileNode;
 
    /// Constructor.
    /// @param pDL           A reference to the main class.
    /// @param pHtmlFileNode The HTML file to read and search for #"XLink"s.
    HTMLReplacer( DoxygenXLinks& pDL, alib::filetree::FTFile pHtmlFileNode )
    : DXLJob(typeid(HTMLReplacer))
    , dxl(pDL)
    , htmlFileNode(pHtmlFileNode)                                                                 {}
 
    /// Overrides the parent function as necessary.
    /// @return The sizeof this derived type.
    size_t      SizeOf()                                   override { return sizeof(HTMLReplacer); }
 
    /// Implements this job.
    /// @return Constant \c true.
    bool        Do()                                                                       override;
};
 
/// This is a job executed by the #"ThreadPool" in class #"DoxygenXLinks".
/// The job loads a source file and searches for locations of the "original" source strings
/// which are found in HTML files. With that information \dxl is enabled to print the location
/// of erroneous \xls.<br>
/// The job just collects the data. The result output is done later in a sorted fashion.
struct SourceLocationFinder : DXLJob  {
    /// The main linker class.
    DoxygenXLinks&      dxl;
 
    /// The source-file to load and search for \dxl links.
    alib::filetree::FTFile   srcFileNode;
 
    /// Constructor.
    /// @param pDL          A reference to the main class.
    /// @param pSrcFileNode The source file to read and search for #"XLink"s.
    SourceLocationFinder( DoxygenXLinks& pDL, alib::filetree::FTFile pSrcFileNode )
    : DXLJob(typeid(SourceLocationFinder))
    , dxl(pDL)
    , srcFileNode(pSrcFileNode)                                                                   {}
 
    /// Overrides the parent function as necessary.
    /// @return The sizeof this derived type.
    size_t      SizeOf()                           override { return sizeof(SourceLocationFinder); }
 
    /// Implements this job.
    /// @return Constant \c true.
    bool        Do()                                                                       override;
};
 
/// This is a job executed by the #"ThreadPool" in class #"DoxygenXLinks".
/// The job loads a source file and searches and replaces \xl.
/// This is used with option <c>--doxyfy</c> to create a version of the sources that are
/// free of \xls which can be used as input to \b Doxygen again for creating other output targets.
struct SourceReplacer : DXLJob  {
    /// The main linker class.
    DoxygenXLinks&      dxl;
 
    /// The source-file to load and search for \dxl links.
    alib::filetree::FTFile   srcFileNode;
 
    /// Constructor.
    /// @param pDL          A reference to the main class.
    /// @param pSrcFileNode The source file to read and replace #"XLink" in.
    SourceReplacer( DoxygenXLinks& pDL, alib::filetree::FTFile pSrcFileNode )
    : DXLJob(typeid(SourceLocationFinder))
    , dxl(pDL)
    , srcFileNode(pSrcFileNode)                                                                   {}
 
    /// Overrides the parent function as necessary.
    /// @return The sizeof this derived type.
    size_t      SizeOf()                           override { return sizeof(SourceLocationFinder); }
 
    /// Implements this job.
    /// @return Constant \c true.
    bool        Do()                                                                       override;
};
 
} //namespace [dxl]
                                                
 
#endif // HPP_DXL_JOB