doxyfile.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_DOXYFILE
#define HPP_DXL_DOXYFILE
#pragma once
 
#include "ALib.Files.H"
 
namespace dxl {
 
// #################################################################################################
/// This class reads a doxygen INI-file and parses the values that DoxygenXLinks needs into its
/// members.
// #################################################################################################
struct DoxygenINIFile {
    /// Represents the tagfile created by the main project or an additional external one which may
    /// optionally specify a documentation location (directory or URL).
    struct TagFileInfo {
        /// Path to the tag-file
        alib::system::PathString  TagFilePath;
 
        /// The base-URL that links in the tag-file are targeting. In case of the main tag-file
        /// of the project (variable <b>GENERATE_TAGFILE</b> in the doxyfile), this string is
        /// \e nulled.
        alib::String              BaseURL;
    };
 
    /// The doxygen output directory for HTML files. This is our input directory.
    /// Read from variables \b HTML_OUTPUT, and, if this is a relative path, from
    /// \b OUTPUT_DIRECTORY.
    alib::system::PathString                HTMLFilePath;
 
    /// The extension of the generated Html-Files.<br>
    /// Read from variable \b HTML_FILE_EXTENSION. Doxygen defaults this to <b>".html"</b>.
    alib::String                            HtmlFileExtension;
 
    /// Specifies the number of subfolders of HTML-files created by Doxygen.
    /// Read from variable \b RECURSIVE
    unsigned                                HtmlSubfolderDepth = 0;
 
    /// Doxygen input files. Those are used to search for non-resolvable or ambiguous links.<p>
    /// Uses variable \b INPUT
    alib::ListMA<alib::system::PathString>  InputPaths;
 
    /// Doxygen input files patterns. Used to filter files in #InputPaths.<p>
    /// Read from variable \b FILE_PATTERNS.
    alib::String                            FilePatterns;
 
    /// A list of files or folders to be excluded<p>
    /// Read from variable \b EXCLUDE.
    alib::ListMA<alib::system::PathString>  ExcludePaths;
 
    /// A list of patterns to exclude from the input file list. Allows wildcards like
    /// <c>*/test/*</c> and patterns are applied to the full path of a file.
    /// Read from variable \b EXCLUDE_PATTERNS
    alib::ListMA<alib::String>              ExcludePatterns;
 
    /// Holds the main documentations' tag-file specified by the variable \b GENERATE_TAGFILE,
    /// together with all external tag-files to use specified by variable \b TAGFILES.<br>
    /// Note that with that, all tag-files are treated with the same precedence.
    alib::ListMA<TagFileInfo>               TagFiles;
 
    /// Determines whether symlinks should be followed or not during input file scan.<p>
    /// Read from variable \b EXCLUDE_SYMLINKS
    bool                                    ExcludeSymlinks = false;
 
    /// Specifies if input folders are recursively scanned for files.
    /// Read from variable \b RECURSIVE
    bool                                    RecursiveInputScan = false;
 
    /// Constructor
    /// @param ma The allocator used to create the data.
    DoxygenINIFile( alib::MonoAllocator& ma )
    : InputPaths(ma)
    , ExcludePaths(ma)
    , ExcludePatterns(ma)  
    , TagFiles(ma)    {}
 
    /// Loads the doxygen INI-file (usually "Doxyfile") and reads the relevant values.
    /// @param filePath The path to the file to open
    void Load(const alib::system::Path& filePath);
 
    /// Writes the contents of this file to the console.
    void Dump() const;
};
 
} // namespace [dxl]
 
#endif // HPP_DXL_DOXYFILE