styles.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_STYLES
#define HPP_DXL_STYLES
#pragma once
#include "target.hpp"
#include "index.hpp"
 
namespace dxl {
class XLink;
class  DoxygenXLinks;
 
 
 
//##################################################################################################
/// Encapsulates the information given with the links that this whole project was created for.
/// Instances represent an XLink to a doxygen #"dxl Target" as given by the user.
//##################################################################################################
class Styles {
    friend class DoxygenXLinks;
 
    
    
  protected:
    /// The maximum number of styles attached by \dxl.
    static constexpr int MAX_STYLES= 7;
 
    /// The original source string.
    const alib::String*     list[MAX_STYLES];
 
    /// The number of styles in #".list".
    int                     size                                                                 =0;
 
    /// This is set when a display text was given to the \xl.
    bool                     isVerbal                                                        =false;
 
    /// This set when a code entity is targeted by the \xl.
    bool                     isCodeEntity                                                    =false;
 
    /// This set when a dir is targeted by the \xl.
    bool                     isDir                                                           =false;
 
    /// This set when a file is targeted by the \xl.
    bool                     isFile                                                          =false;
 
  public:
 
    static constexpr alib::String  EL         = "el";               ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  ELRef      = "elRef";            ///< CSS class name. See user manual chapter #"dxl_styling".
 
    static constexpr alib::String  Doc        = "xl-doc";           ///< CSS class name. See user manual chapter #"dxl_styling".
 
    static constexpr alib::String  File       = "xl-file";          ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  SrcFile    = "xl-srcfile";       ///< todo: only set with EL/ELRef today.
    static constexpr alib::String  SrcFileLine= "xl-srcline";       ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  Dir        = "xl-dir";           ///< CSS class name. See user manual chapter #"dxl_styling".
 
    static constexpr alib::String  Code       = "xl-entity";        ///< CSS class name. See user manual chapter #"dxl_styling".
 
    static constexpr alib::String  Macro      = "xl-macro";         ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  Typedef    = "xl-typedef";       ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  Module     = "xl-module";       ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  Concept    = "xl-concept";       ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  Namespace  = "xl-ns";            ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  Struct     = "xl-struct";        ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  Class      = "xl-class";         ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  Union      = "xl-union";         ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  Enum       = "xl-enum";          ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  EnumElem   = "xl-enumelem";      ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  Var        = "xl-var";           ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  Func       = "xl-func";          ///< CSS class name. See user manual chapter #"dxl_styling".
 
    static constexpr alib::String  FileOrDir  = "xl-filedir";       ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  Record     = "xl-record";        ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  Template   = "xl-template";      ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  TemplSpec  = "xl-tempspec";      ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  Indirect   = "xl-indirect";      ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  NsMem      = "xl-in-ns";         ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  RecMem     = "xl-in-rec";        ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  WithDisp   = "xl-display";       ///< CSS class name. See user manual chapter #"dxl_styling".
 
 
    static constexpr alib::String  XLEL       = "xl-el";            ///< CSS class name. See user manual chapter #"dxl_styling".
    static constexpr alib::String  ELUnknown  = "xl-elukn";         ///< CSS class name. See user manual chapter #"dxl_styling".
 
    /// Constructor.
    Styles()                                                                               =default;
 
    /// Receives the number of style-classes set.
    /// @return The number of style-classes set.
    int              Size()                                                   const { return size; }
 
    ///@return \c true if a display text was given to the \xl, false otherwise.
    bool             IsVerbal()                                           const { return isVerbal; }
 
    ///@return \c true if a code entity is targeted by the \xl, false otherwise.
    bool             IsCodeEntity()                                   const { return isCodeEntity; }
    
    ///@return \c true if a directory is targeted by the \xl, false otherwise.
    bool             IsDir()                                                 const { return isDir; }
 
    ///@return \c true if a file is targeted by the \xl, false otherwise.
    bool             IsFile()                                               const { return isFile; }
 
    /// Receives a style-class string.
    /// @param idx The index requested
    /// @return The class with the given \p{idx}.
    const alib::String&    Get(int idx)                                                        const
    { ALIB_ASSERT( idx< size, "DXL/STYLES") return *list[idx]; }
 
    /// Adds the given \p{style} class string to this list of styles.
    /// @param style           The target node.
    void   Add( const alib::String& style )
    { ALIB_ASSERT( size< MAX_STYLES, "DXL/STYLES") list[size++]= &style; }
 
    /// Sets the styles from the given parameters.
    /// \note Additional styles are defined and set with the method #"GetELDecoration;2".
    /// @param node           The target-node to set the styles for.
    /// @param hasDisplayText Denotes whether a dedicated display text was given to the \xl.
    /// @param isIndirect     Denotes whether a type-definition or an inherited member was resolved.
    void   Set( const Index::Node& node, bool hasDisplayText, bool isIndirect);
 
};
 
} //namespace [dxl]
 
 
#endif // HPP_DXL_STYLES