layout.cpp File Reference

#include <array>
#include <assert.h>
#include "types.h"
#include "layout.h"
#include "message.h"
#include "language.h"
#include "util.h"
#include "doxygen.h"
#include "version.h"
#include "config.h"
#include "xml.h"
#include "resourcemgr.h"
#include "docparser.h"
#include "docnode.h"
#include "debug.h"
#include "regex.h"

Include dependency graph for layout.cpp:

Go to the source code of this file.

Classes
class	LayoutParser
struct	anonymous_namespace{layout.cpp}::ElementCallbacks
class	LayoutDocManager::Private

Namespaces
namespace	anonymous_namespace{layout.cpp}

Functions
QCString	compileOptions (const QCString &def)
QCString	compileOptions (const QCString &def, SrcLangExt langId1, const QCString &value1)
QCString	compileOptions (const QCString &def, SrcLangExt langId1, const QCString &value1, SrcLangExt langId2, const QCString &value2)
QCString	compileOptions (const QCString &def, SrcLangExt langId1, const QCString &value1, SrcLangExt langId2, const QCString &value2, SrcLangExt langId3, const QCString &value3)
QCString	compileOptions (const QCString &def, SrcLangExt langId1, const QCString &value1, SrcLangExt langId2, const QCString &value2, SrcLangExt langId3, const QCString &value3, SrcLangExt langId4, const QCString &value4)
QCString	compileOptions (const QCString &def, SrcLangExt langId1, const QCString &value1, SrcLangExt langId2, const QCString &value2, SrcLangExt langId3, const QCString &value3, SrcLangExt langId4, const QCString &value4, SrcLangExt langId5, const QCString &value5)
static bool	elemIsVisible (const XMLHandlers::Attributes &attrib, bool defVal=TRUE)
template<class... Args>
static auto	anonymous_namespace{layout.cpp}::startCb (void(LayoutParser::*fn)(Args...))
template<class... Args>
static auto	anonymous_namespace{layout.cpp}::startCb (void(LayoutParser::*fn)(Args...), LayoutDocEntry::Kind kind)
template<class... Args>
static auto	anonymous_namespace{layout.cpp}::startCb (void(LayoutParser::*fn)(Args...), LayoutDocEntry::Kind kind, const std::function< QCString()> &title)
template<class... Args>
static auto	anonymous_namespace{layout.cpp}::startCb (void(LayoutParser::*fn)(Args...), MemberListType type, const std::function< QCString()> &title)
template<class... Args>
static auto	anonymous_namespace{layout.cpp}::startCb (void(LayoutParser::*fn)(Args...), MemberListType type, const std::function< QCString()> &title, const std::function< QCString()> &subtitle)
template<class... Args>
static auto	anonymous_namespace{layout.cpp}::startCb (void(LayoutParser::*fn)(Args...), LayoutDocManager::LayoutPart part, const QCString &scope, LayoutNavEntry::Kind nav)
template<class... Args>
static auto	anonymous_namespace{layout.cpp}::endCb (void(LayoutParser::*fn)(Args...))
static LayoutNavEntry *	findNavEntryRec (LayoutNavEntry *root, const std::string &id)
static void	mergeNavTreeNodesRec (LayoutNavEntry *targetTree, LayoutNavEntry *sourceTree)
static void	mergeDocEntryLists (const QCString &fileName, LayoutDocEntryList &targetList, LayoutDocEntryList &sourceList)
void	writeDefaultLayoutFile (const QCString &fileName)
QCString	extractLanguageSpecificTitle (const QCString &input, SrcLangExt lang)
static void	printNavLayout (LayoutNavEntry *root, int indent)
void	printLayout ()

Variables
static const std::map< std::string, ElementCallbacks >	anonymous_namespace{layout.cpp}::g_elementHandlers

Function Documentation

compileOptions() [1/6]

QCString compileOptions ( const QCString & def )

inline

Definition at line 35 of file layout.cpp.

{
  return def;
}

Referenced by compileOptions(), compileOptions(), compileOptions(), compileOptions(), and compileOptions().

compileOptions() [2/6]

QCString compileOptions ( const QCString & def, SrcLangExt langId1, const QCString & value1 )

inline

Definition at line 40 of file layout.cpp.

{
  return compileOptions(def)+"|"+QCString().setNum(static_cast<long>(langId1))+"="+value1;
}

References compileOptions(), and QCString::setNum().

compileOptions() [3/6]

QCString compileOptions ( const QCString & def, SrcLangExt langId1, const QCString & value1, SrcLangExt langId2, const QCString & value2 )

inline

Definition at line 45 of file layout.cpp.

{
  return compileOptions(def,langId1,value1)+
         "|"+QCString().setNum(static_cast<long>(langId2))+"="+value2;
}

References compileOptions(), and QCString::setNum().

compileOptions() [4/6]

QCString compileOptions ( const QCString & def, SrcLangExt langId1, const QCString & value1, SrcLangExt langId2, const QCString & value2, SrcLangExt langId3, const QCString & value3 )

inline

Definition at line 52 of file layout.cpp.

{
  return compileOptions(def,langId1,value1,langId2,value2)+
         "|"+QCString().setNum(static_cast<long>(langId3))+"="+value3;
}

References compileOptions(), and QCString::setNum().

compileOptions() [5/6]

QCString compileOptions ( const QCString & def, SrcLangExt langId1, const QCString & value1, SrcLangExt langId2, const QCString & value2, SrcLangExt langId3, const QCString & value3, SrcLangExt langId4, const QCString & value4 )

inline

Definition at line 60 of file layout.cpp.

{
  return compileOptions(def,langId1,value1,langId2,value2,langId3,value3)+
         "|"+QCString().setNum(static_cast<long>(langId4))+"="+value4;
}

References compileOptions(), and QCString::setNum().

compileOptions() [6/6]

QCString compileOptions ( const QCString & def, SrcLangExt langId1, const QCString & value1, SrcLangExt langId2, const QCString & value2, SrcLangExt langId3, const QCString & value3, SrcLangExt langId4, const QCString & value4, SrcLangExt langId5, const QCString & value5 )

inline

Definition at line 69 of file layout.cpp.

{
  return compileOptions(def,langId1,value1,langId2,value2,langId3,value3,langId4,value4)+
         "|"+QCString().setNum(static_cast<long>(langId5))+"="+value5;
}

References compileOptions(), and QCString::setNum().

elemIsVisible()

bool elemIsVisible ( const XMLHandlers::Attributes & attrib, bool defVal = TRUE )

static

Definition at line 79 of file layout.cpp.

{
  QCString visible = XMLHandlers::value(attrib,"visible");
  //printf("visible_attribute=%s\n",qPrint(visible));
  if (visible.isEmpty()) return defVal;
  if (visible.at(0)=='$' && visible.length()>1)
  {
    QCString id = visible.mid(1);
    const ConfigValues::Info *opt = ConfigValues::instance().get(id);
    if (opt && opt->type==ConfigValues::Info::Bool)
    {
      return ConfigValues::instance().*(opt->value.b);
    }
    else if (opt && opt->type==ConfigValues::Info::String)
    {
      return opt->getBooleanRepresentation();
    }
    else if (!opt)
    {
      err("found unsupported value '{}' for visible attribute in layout file, reverting to '{}'\n",
          visible,(defVal?"yes":"no"));
      return defVal;
    }
  }
  QCString visibleLow = visible.lower();
  if (visibleLow=="no" || visibleLow=="false" || visibleLow=="0") return FALSE;
  else if (visibleLow=="yes" || visibleLow=="true" || visibleLow=="1") return TRUE;
  else
  {
    err("found unsupported value '{}' for visible attribute in layout file, reverting to '{}'\n",
        visible,(defVal?"yes":"no"));
    return defVal;
  }
}

References QCString::at(), err, FALSE, QCString::isEmpty(), QCString::length(), QCString::lower(), QCString::mid(), TRUE, and XMLHandlers::value().

Referenced by LayoutParser::startMemberDecl(), LayoutParser::startMemberDeclEntry(), LayoutParser::startMemberDef(), LayoutParser::startMemberDefEntry(), LayoutParser::startNavEntry(), LayoutParser::startSectionEntry(), LayoutParser::startSimpleEntry(), and LayoutParser::startTop().

extractLanguageSpecificTitle()

QCString extractLanguageSpecificTitle	(	const QCString &	input,
		SrcLangExt	lang )

Definition at line 1758 of file layout.cpp.

{
  int s=0,e=input.find('|');
  if (e==-1) return input; // simple title case
  int e1=e;
  while (e!=-1) // look for 'number=title' pattern separated by '|'
  {
    s=e+1;
    e=input.find('|',s);
    int i=input.find('=',s);
    assert(i>s);
    SrcLangExt key= static_cast<SrcLangExt>(input.mid(s,i-s).toUInt());
    if (key==lang) // found matching key
    {
      if (e==-1) e=static_cast<int>(input.length());
      return input.mid(i+1,e-i-1);
    }
  }
  return input.left(e1); // fallback, no explicit language key found
}

References QCString::find(), QCString::left(), QCString::length(), and QCString::mid().

Referenced by LayoutDocEntryMemberDecl::subtitle(), LayoutDocEntryMemberDecl::title(), LayoutDocEntryMemberDef::title(), and LayoutDocEntrySection::title().

findNavEntryRec()

LayoutNavEntry * findNavEntryRec ( LayoutNavEntry * root, const std::string & id )

static

Definition at line 1542 of file layout.cpp.

{
  if (root)
  {
    if (root->id()==id) return root;
    for (auto &child : root->children())
    {
      LayoutNavEntry *childNavEntry = findNavEntryRec(child.get(),id);
      if (childNavEntry) return childNavEntry;
    }
  }
  return nullptr;
}

References LayoutNavEntry::children(), findNavEntryRec(), and LayoutNavEntry::id().

Referenced by findNavEntryRec(), and mergeNavTreeNodesRec().

mergeDocEntryLists()

void mergeDocEntryLists ( const QCString & fileName, LayoutDocEntryList & targetList, LayoutDocEntryList & sourceList )

static

Definition at line 1640 of file layout.cpp.

{
  using IdSet = std::unordered_set<std::string>;
  using IdMap = std::unordered_map<std::string,size_t>;
 
  auto prepareSet = [](const LayoutDocEntryList &list, IdSet &set) {
    //size_t idx=0;
    for (const auto &e : list)
    {
      //printf("idx=%zu set(%s)\n",idx,qPrint(e->id()));
      set.insert(e->id());
      //idx++;
    }
  };
 
  auto prepareMap = [](const LayoutDocEntryList &list, const IdSet &set, IdMap &map) {
    for (size_t i=0; i<list.size(); i++)
    {
      std::string id = list[i]->id();
      auto it = set.find(id);
      if (it != set.end())
      {
        //printf("map %s->%zu\n",qPrint(id),i);
        map[id]=i;
      }
    }
  };
 
  IdSet sourceSet, targetSet;
  //printf("---- sourceSet\n");
  prepareSet(sourceList,sourceSet);
  //printf("---- targetSet\n");
  prepareSet(targetList,targetSet);
 
  IdMap sourceMap, targetMap;
  //printf("---- targetMap\n");
  prepareMap(targetList,sourceSet,targetMap);
  //printf("---- sourceMap\n");
  prepareMap(sourceList,targetSet,sourceMap);
 
  // calculate list of insertion positions in the target list for each id in the source list
  std::vector<size_t> insertionList;
  for (size_t i=0; i<sourceList.size(); i++)
  {
    std::string id = sourceList[i]->id();
    // If an id in the source list appears before a set of shared ids we want it also to
    // appear before these id in the target list. To do this find the lowest target index of all shared
    // ids that come after position i in the source list
    size_t minIdx = targetList.size();
    for (const auto &kv : sourceMap) // iterator over shared ids
    {
      if (i < kv.second) // i appears before this shared id
      {
        size_t idx = targetMap[kv.first]; // get the corresponding index in the target list
        //printf("  evaluating %s->%zu min=%zu\n",qPrint(kv.first),idx,minIdx);
        if (idx<minIdx) // update minimum
        {
          minIdx=idx;
        }
      }
    }
    //printf("insertion %s->%zu\n",qPrint(id),minIdx);
    insertionList.push_back(minIdx);
  }
 
  // Insert the missing elements of the source list into the target list.
  // Work backwards so the calculated insertion points don't change due to insertions.
  size_t idx = sourceList.size()-1;
  for (auto it=insertionList.rbegin(); it!=insertionList.rend(); ++it, idx--)
  {
    std::string id = sourceList[idx]->id();
    //printf("idx=%zu entry %s\n",idx,qPrint(id));
    if (targetSet.find(id)==targetSet.end()) // need to add id
    {
      // for efficiency we move the elements from the source list to the target list, thus modifying the source list!
      //printf("--> insert at %zu before %s\n",*it,qPrint(*it<targetList.size()?targetList[*it]->id():"none"));
      warn_layout(fileName,1,"User defined layout misses entry '{}'. Using default value.",id);
      targetList.insert(targetList.begin()+*it, std::move(sourceList[idx]));
    }
  }
 
}

References warn_layout.

Referenced by LayoutDocManager::mergeDocEntries().

mergeNavTreeNodesRec()

void mergeNavTreeNodesRec ( LayoutNavEntry * targetTree, LayoutNavEntry * sourceTree )

static

Definition at line 1557 of file layout.cpp.

{
  using IdSet = std::unordered_set<std::string>;
  using IdMap = std::unordered_map<std::string,size_t>;
 
  auto prepareSet = [](const LayoutNavEntry *tree, IdSet &set) {
    for (const auto &e : tree->children())
    {
      set.insert(e->id());
    }
  };
 
  auto prepareMap = [](const LayoutNavEntry *tree, const IdSet &set, IdMap &map) {
    for (size_t i=0; i<tree->children().size(); i++)
    {
      std::string id = tree->children()[i]->id();
      auto it = set.find(id);
      if (it != set.end())
      {
        map[id]=i;
      }
    }
  };
 
  IdSet sourceSet, targetSet;
  prepareSet(sourceTree,sourceSet);
  prepareSet(targetTree,targetSet);
 
  IdMap sourceMap, targetMap;
  prepareMap(targetTree,sourceSet,targetMap);
  prepareMap(sourceTree,targetSet,sourceMap);
 
  // calculate list of insertion positions in the target list for each id in the source list
  std::vector<size_t> insertionList;
  for (size_t i=0; i<sourceTree->children().size(); i++)
  {
    std::string id = sourceTree->children()[i]->id();
    // If an id in the source list appears before a set of shared ids we want it also to
    // appear before these id in the target list. To do this find the lowest target index of all shared
    // ids that come after position i in the source list
    size_t minIdx = targetTree->children().size();
    for (const auto &kv : sourceMap) // iterator over shared ids
    {
      if (i < kv.second) // i appears before this shared id
      {
        size_t idx = targetMap[kv.first]; // get the corresponding index in the target list
        if (idx<minIdx) // update minimum
        {
          minIdx=idx;
        }
      }
    }
    insertionList.push_back(minIdx);
  }
 
  // Insert the missing elements of the source list into the target list.
  // Work backwards so the calculated insertion points don't change due to insertions.
  size_t idx = sourceTree->children().size()-1;
  for (auto it=insertionList.rbegin(); it!=insertionList.rend(); ++it, idx--)
  {
    std::string id = sourceTree->children()[idx]->id();
    if (targetSet.find(id)==targetSet.end()) // need to add id
    {
      // for efficiency we move the elements from the source list to the target list, thus modifying the source list!
      targetTree->insertChild(*it, std::move(sourceTree->children()[idx]));
    }
  }
 
  for (auto &targetChild : targetTree->children())
  {
    auto *node = findNavEntryRec(sourceTree,targetChild->id());
    if (node)
    {
      mergeNavTreeNodesRec(targetChild.get(),node);
    }
  }
}

References LayoutNavEntry::children(), findNavEntryRec(), LayoutNavEntry::id(), LayoutNavEntry::insertChild(), and mergeNavTreeNodesRec().

Referenced by LayoutDocManager::mergeNavEntries(), and mergeNavTreeNodesRec().

printLayout()

void printLayout

(

)

Definition at line 1822 of file layout.cpp.

{
  bool extraIndent = false;
 
  auto &mgr = LayoutDocManager::instance();
  Debug::print(Debug::Layout,0,"Layout version {}.{}\n",mgr.majorVersion(),mgr.minorVersion());
 
  Debug::print(Debug::Layout,0,"Part: Navigation index\n");
  for (const auto &e : mgr.rootNavEntry()->children())
  {
    printNavLayout(e.get(),2);
  }
 
  for (int i = 0; i < LayoutDocManager::NrParts; i++)
  {
     Debug::print(Debug::Layout,0,"\nPart: {}\n", LayoutDocManager::partToString(i));
     for (const auto &lde : mgr.docEntries(static_cast<LayoutDocManager::LayoutPart>(i)))
     {
       if (const LayoutDocEntrySimple *ldes = dynamic_cast<const LayoutDocEntrySimple*>(lde.get()))
       {
         if (lde->kind() == LayoutDocEntry::MemberDeclEnd || lde->kind() == LayoutDocEntry::MemberDefEnd) extraIndent = false;
         Debug::print(Debug::Layout,0,"  {}kind: {}, visible={}\n",
           extraIndent? "  " : "",lde->entryToString(), ldes->visible());
         if (lde->kind() == LayoutDocEntry::MemberDeclStart || lde->kind() == LayoutDocEntry::MemberDefStart) extraIndent = true;
       }
       else if (const LayoutDocEntryMemberDecl *lmdecl = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get()))
       {
         Debug::print(Debug::Layout,0,"  {}complex kind: {}, visible={}, type: {}\n",
           extraIndent? "  " : "",lde->entryToString(),lmdecl->visible(),lmdecl->type.to_string());
       }
       else if (const LayoutDocEntryMemberDef *lmdef = dynamic_cast<const LayoutDocEntryMemberDef*>(lde.get()))
       {
         Debug::print(Debug::Layout,0,"  {}complex kind: {}, visible={}, type: {}\n",
           extraIndent? "  " : "",lde->entryToString(),lmdef->visible(),lmdef->type.to_string());
       }
       else
       {
         // should not happen
         Debug::print(Debug::Layout,0,"  {}not handled kind: {}\n",extraIndent? "  " : "",lde->entryToString());
       }
     }
  }
}

References LayoutDocManager::instance(), Debug::Layout, LayoutDocManager::partToString(), Debug::print(), and printNavLayout().

Referenced by LayoutDocManager::LayoutParser, and parseInput().

printNavLayout()

void printNavLayout ( LayoutNavEntry * root, int indent )

static

Definition at line 1807 of file layout.cpp.

{
  if (Debug::isFlagSet(Debug::Layout))
  {
    QCString indentStr;
    indentStr.fill(' ',indent);
    Debug::print(Debug::Layout,0,"{}kind={} visible={} title='{}'\n",
        indentStr, root->navToString(), root->visible(), root->title());
    for (const auto &e : root->children())
    {
      printNavLayout(e.get(),indent+2);
    }
  }
}

References LayoutNavEntry::children(), QCString::fill(), Debug::isFlagSet(), Debug::Layout, LayoutNavEntry::navToString(), Debug::print(), printNavLayout(), LayoutNavEntry::title(), and LayoutNavEntry::visible().

Referenced by printLayout(), and printNavLayout().

writeDefaultLayoutFile()

void writeDefaultLayoutFile

(

const QCString &

fileName

)

Definition at line 1734 of file layout.cpp.

{
  std::ofstream f;
  if (openOutputFile(fileName,f))
  {
    TextStream t(&f);
    QCString layout_default = ResourceMgr::instance().getAsString("layout_default.xml");
    t << substitute(layout_default,"$doxygenversion",getDoxygenVersion());
  }
  else
  {
    err("Failed to open file {} for writing!\n",fileName);
    return;
  }
  f.close();
}

References err, ResourceMgr::getAsString(), ResourceMgr::instance(), openOutputFile(), and substitute().

Referenced by LayoutDocManager::LayoutParser, and readConfiguration().