Making settings fro settings file available.

Making the settings from the doxygen settings / configuration file directly available inside the documentation.

Author: albert-github

doc/commands.doc

@@ -78,6 +78,7 @@ documentation:
 \refitem cmddontinclude \\dontinclude
 \refitem cmddot \\dot
 \refitem cmddotfile \\dotfile
+\refitem cmddoxysetting \\doxysetting
 \refitem cmde \\e
 \refitem cmdelse \\else
 \refitem cmdelseif \\elseif
@@ -3136,6 +3137,21 @@ class Receiver
   \ref image_sizeindicator "Size indication" with the
   \ref cmdimage "\\image" command.
 
+<hr>
+\section cmddoxysetting \\doxysetting <setting>
+
+  \addindex \\doxysetting
+  Dispays the value of the setting of `<setting>` as used in the doxygen
+  configuration file for this doxygen run.
+
+  \par Example:
+  When creating this manual the following:
+  \verbatim
+  ... Project name = \doxysetting  PROJECT_NAME ...
+  \endverbatim
+  gives:<br>
+  ... Project name = \doxysetting  PROJECT_NAME ...
+
 <hr>
 \section cmde \\e <word>
 

src/cmdmapper.cpp

@@ -42,6 +42,7 @@ CommandMap cmdMap[] =
   { "date",          CMD_DATE },
   { "dontinclude",   CMD_DONTINCLUDE },
   { "dotfile",       CMD_DOTFILE },
+  { "doxysetting",   CMD_DOXYSETTING },
   { "e",             CMD_EMPHASIS },
   { "em",            CMD_EMPHASIS },
   { "endcode",       CMD_ENDCODE },

src/cmdmapper.h

@@ -143,6 +143,7 @@ enum CommandType
   CMD_MANINCLUDE   = 114,
   CMD_XMLINCLUDE   = 115,
   CMD_ILINE        = 116,
+  CMD_DOXYSETTING  = 117,
 };
 
 enum HtmlTagType

src/docparser.cpp

@@ -51,6 +51,8 @@
 #include "emoji.h"
 #include "fileinfo.h"
 #include "dir.h"
+#include "configimpl.h"
+#include "configoptions.h"
 
 #define TK_COMMAND_CHAR(token) ((token)==TK_COMMAND_AT ? "@" : "\\")
 
@@ -4791,6 +4793,107 @@ void DocPara::handleCite()
   m_parser.tokenizer.setStatePara();
 }
 
+void DocPara::handleDoxySetting()
+{
+  // get the argument of the cite command.
+  int tok=m_parser.tokenizer.lex();
+  if (tok!=TK_WHITESPACE)
+  {
+    warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"expected whitespace after \\%s command",
+        qPrint("doxysetting"));
+    return;
+  }
+  m_parser.tokenizer.setStateDoxySetting();
+  tok=m_parser.tokenizer.lex();
+  if (tok==0)
+  {
+    warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"unexpected end of comment block while parsing the "
+        "argument of command %s\n", qPrint("doxysetting"));
+    return;
+  }
+  else if (tok!=TK_WORD && tok!=TK_LNKWORD)
+  {
+    warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"unexpected token %s as the argument of %s",
+        DocTokenizer::tokToString(tok),qPrint("doxysetting"));
+    return;
+  }
+  ConfigOption * opt = ConfigImpl::instance()->get(m_parser.context.token->name);
+  if (opt)
+  {
+    switch (opt->kind())
+    {
+      case ConfigOption::O_Bool:
+        m_children.push_back(std::make_unique<DocWord>(m_parser,this,*(dynamic_cast<ConfigBool*>(opt)->valueStringRef())));
+        break;
+      case ConfigOption::O_String:
+        m_children.push_back(std::make_unique<DocWord>(m_parser,this,*(dynamic_cast<ConfigString*>(opt)->valueRef())));
+        break;
+      case ConfigOption::O_Enum:
+        m_children.push_back(std::make_unique<DocWord>(m_parser,this,*(dynamic_cast<ConfigEnum*>(opt)->valueRef())));
+        break;
+      case ConfigOption::O_Int:
+        m_children.push_back(std::make_unique<DocWord>(m_parser,this,*(dynamic_cast<ConfigInt*>(opt)->valueStringRef())));
+        break;
+      case ConfigOption::O_List:
+        {
+          StringVector *lst = dynamic_cast<ConfigList*>(opt)->valueRef();
+          if (!lst->empty())
+          {
+            std::string lstFormat = theTranslator->trWriteList(lst->size()).str();
+            static const reg::Ex marker(R"(@(\d+))");
+            reg::Iterator it(lstFormat,marker);
+            reg::Iterator end;
+            size_t index=0;
+            QCString newList;
+            // now replace all markers with the real text
+            for ( ; it!=end ; ++it)
+            {
+              const auto &match = *it;
+              size_t newIndex = match.position();
+              size_t matchLen = match.length();
+              newList += lstFormat.substr(index,newIndex-index);
+              unsigned long entryIndex = std::stoul(match[1].str());
+              if (entryIndex<(unsigned long)lst->size())
+              {
+                newList += lst->at(entryIndex);
+              }
+              index=newIndex+matchLen;
+            }
+            m_children.push_back(std::make_unique<DocWord>(m_parser,this,newList));
+          }
+        }
+        break;
+      case ConfigOption::O_Obsolete:
+        warn(m_parser.context.fileName,m_parser.tokenizer.getLineNr(), "Obsolete setting for '\\doxysetting': '%s'",
+              qPrint(m_parser.context.token->name));
+        m_children.push_back(std::make_unique<DocWord>(m_parser,this,m_parser.context.token->name + " (obsolete)"));
+        break;
+      case ConfigOption::O_Disabled:
+        warn(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),
+              "Disabled setting (i.e. not supported in this doxygen executable) for '\\doxysetting': '%s'",
+              qPrint(m_parser.context.token->name));
+        m_children.push_back(std::make_unique<DocWord>(m_parser,this,m_parser.context.token->name + " (Disabled)"));
+        break;
+      default:
+        break;
+    }
+  }
+  else
+  {
+    warn(m_parser.context.fileName,m_parser.tokenizer.getLineNr(), "Unknown setting for '\\doxysetting': '%s'",
+         qPrint(m_parser.context.token->name));
+    m_children.push_back(std::make_unique<DocWord>(m_parser,this,m_parser.context.token->name));
+  }
+  #if 0
+  m_parser.context.token->sectionId = m_parser.context.token->name;
+  m_children.push_back(
+      std::make_unique<DocCite>(
+        m_parser,this,m_parser.context.token->name,m_parser.context.context));
+
+  #endif
+  m_parser.tokenizer.setStatePara();
+}
+
 void DocPara::handleEmoji()
 {
   // get the argument of the emoji command.
@@ -5877,6 +5980,9 @@ int DocPara::handleCommand(const QCString &cmdName, const int tok)
     case CMD_CITE:
       handleCite();
       break;
+    case CMD_DOXYSETTING:
+      handleDoxySetting();
+      break;
     case CMD_EMOJI:
       handleEmoji();
       break;

src/docparser.h

@@ -1202,6 +1202,7 @@ class DocPara : public CompAccept<DocPara>
     void handleInclude(const QCString &cmdName,DocInclude::Type t);
     void handleLink(const QCString &cmdName,bool isJavaLink);
     void handleCite();
+    void handleDoxySetting();
     void handleEmoji();
     void handleRef(const QCString &cmdName);
     void handleSection(const QCString &cmdName);

src/doctokenizer.h

@@ -158,6 +158,7 @@ class DocTokenizer
     void setStatePattern();
     void setStateLink();
     void setStateCite();
+    void setStateDoxySetting();
     void setStateRef();
     void setStateInternalRef();
     void setStateText();

src/doctokenizer.l

@@ -236,6 +236,7 @@ PHPTYPE   [\\:a-z_A-Z0-9\x80-\xFF\-]+
 CITESCHAR [a-z_A-Z0-9\x80-\xFF\-\?]
 CITEECHAR [a-z_A-Z0-9\x80-\xFF\-\+:\/\?]
 CITEID    {CITESCHAR}{CITEECHAR}*("."{CITESCHAR}{CITEECHAR}*)*|"\""{CITESCHAR}{CITEECHAR}*("."{CITESCHAR}{CITEECHAR}*)*"\""
+DOXYSET   [a-z_A-Z][a-z_A-Z0-9]*
 MAILADDR  ("mailto:")?[a-z_A-Z0-9.+-]+"@"[a-z_A-Z0-9-]+("."[a-z_A-Z0-9\-]+)+[a-z_A-Z0-9\-]+
 MAILWS    [\t a-z_A-Z0-9+-]
 MAILADDR2 {MAILWS}+{BLANK}+("at"|"AT"|"_at_"|"_AT_"){BLANK}+{MAILWS}+("dot"|"DOT"|"_dot_"|"_DOT_"){BLANK}+{MAILWS}+
@@ -343,6 +344,7 @@ LINENR {BLANK}*[1-9][0-9]*
 %x St_Pattern
 %x St_Link
 %x St_Cite
+%x St_DoxySetting
 %x St_Ref
 %x St_Ref2
 %x St_IntRef
@@ -1019,6 +1021,30 @@ LINENR {BLANK}*[1-9][0-9]*
                          unput(*yytext);
                          return 0;
                        }
+<St_DoxySetting>{DOXYSET} { // label to cite
+                         if (yytext[0] =='"')
+                         {
+                           yyextra->token->name=yytext+1;
+                           yyextra->token->name=yyextra->token->name.left(static_cast<uint>(yyleng)-2);
+                         }
+                         else
+                         {
+                           yyextra->token->name=yytext;
+                         }
+                         return TK_WORD;
+                       }
+<St_DoxySetting>{BLANK} { // white space
+                         unput(' ');
+                         return 0;
+                       }
+<St_DoxySetting>(\n|"\\ilinebr")  { // new line
+                         unput_string(yytext,yyleng);
+                         return 0;
+                       }
+<St_DoxySetting>.      { // any other character
+                         unput(*yytext);
+                         return 0;
+                       }
 <St_Ref>{REFWORD_NOCV}/{BLANK}("const")[a-z_A-Z0-9] { // see bug776988
                          yyextra->token->name=yytext;
                          return TK_WORD;
@@ -1820,6 +1846,13 @@ void DocTokenizer::setStateCite()
   BEGIN(St_Cite);
 }
 
+void DocTokenizer::setStateDoxySetting()
+{
+  yyscan_t yyscanner = p->yyscanner;
+  struct yyguts_t *yyg = (struct yyguts_t*)yyscanner;
+  BEGIN(St_DoxySetting);
+}
+
 void DocTokenizer::setStateRef()
 {
   yyscan_t yyscanner = p->yyscanner;