dxlapp.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_APP
#define HPP_DXL_APP
#pragma once
#include "ALib.ThreadModel.H"
#include "ALib.Files.H"
#include "ALib.App.CLI.H"
 
namespace dxl {
 
class  DoxygenXLinks;
class  Index;
struct DoxygenINIFile;
 
DOX_MARKER([DOX_TEMPLATE_FUNCTIONS])
/// Template 1
/// @param  a An A.
/// @tparam T Any type.
template<typename T> void foo(T a) {(void)a;}
 
/// Template 2
/// @param  a  An A.
/// @tparam N  Type int.
template<int N>      void foo(int a) {(void)a;}
DOX_MARKER([DOX_TEMPLATE_FUNCTIONS])
 
// #################################################################################################
/// class DXLApp
// #################################################################################################
class DXLApp  : public alib::app::AppCli  {
  friend struct DoxygenINIFile;
  friend class  DoxygenXLinks;
  friend class  Index;
  friend class  XLink;
  friend struct HTMLReplacer;
  friend struct SourceLocationFinder;
  friend struct SourceReplacer;
  friend void DbgUnitTests(DoxygenXLinks*);
 
  protected:
    /// The instance of the main class.  todox
    DoxygenXLinks* dxl= nullptr; // todo: make public and remove the friends above
 
    /// The working directory. Either given with --PWD or detected as the current execution
    /// directory.
    alib::Path PWD;
 
    /// The file path of the Doxyfile as given on the command line.
    alib::String DoxyfilePath= nullptr;
 
    /// Sets the field #"App::appVersion" and then invokes the parent implementation
    /// #"AppCli::onBsSetNameVersionAndInfo".
    void        onBsSetNameVersionAndInfo()                                                override;
 
    /// Todo: remove test: onBsPrepareResources() 
    /// Todo: probably removed.
    /// @param e The exception to be analyzed.
    /// @return todo
    alib::Enum  exceptionToExitCode( alib::Exception& e )                                  override;
 
    /// Defines \alib_cli entities specific to \dxl.
    void        bsCLIDefine()                                override;
 
    /// Bulk-loads \dxl specific resource strings into module #"APPCLI_CAMP".
    void onBsPrepareResources() override;
 
    /// Bootstraps enum records.
    void onBsPrepareConfig() override;
 
    /// Waits for our thread-pool to become idle, shuts it down, and deletes it.
    void onRunEnd() override;
 
  ///  Processes \dxl commands.
  /// @param cmd The command to process or \c nullptr for default execution.
  /// @return  \c true if the command was processed. \c false otherwise.
  bool        cliProcessCmd(alib::cli::Command* cmd )                                    override;
 
    /// Custom #"App::States" of this #"AppCli" application.
    enum class CustomStates {
        CLIDefine          ,  ///< Inserted before App::PrepareConfig.
        ReadDryRunOption   ,  ///< Inserted before SetupALox.
        ConfigureCLI       ,  ///< Inserted after ImportConfig.
    };
 
  public:
    /// Constructor.
    DXLApp();
 
  // #############################################################################################
  // alib::App overrides
  // #############################################################################################
    ///@return The release lox of this application.
    ///        This component of \alibmod_nl \alib_alox is used to generate verbose output accross
    ///        this project.
    alib::lox::Lox*  GetRLox()                                       final { return releaseLox; }
}; // class DXLApp
 
 
 
} //namespace [dxl]
 
#endif // HPP_DXL_APP