NamespaceLinkedRefMap Class Reference

#include <src/namespacedef.h>

Inheritance diagram for NamespaceLinkedRefMap:

Collaboration diagram for NamespaceLinkedRefMap:

Public Member Functions
void	writeDeclaration (OutputList &ol, const DString &title, bool isConstantGroup=false, bool localName=false)
bool	declVisible (bool isContantGroup) const
Public Member Functions inherited from LinkedRefMap< const NamespaceDef >
const const NamespaceDef *	find (const std::string &key) const
bool	add (const char *k, const NamespaceDef *obj)
bool	prepend (const char *k, const NamespaceDef *obj)
bool	del (const DString &key)
Ptr &	operator[] (size_t pos)
iterator	begin ()
iterator	end ()
reverse_iterator	rbegin ()
reverse_iterator	rend ()
bool	empty () const
size_t	size () const
void	clear ()

Additional Inherited Members
Public Types inherited from LinkedRefMap< const NamespaceDef >
using	Ptr
using	Vec
using	iterator
using	const_iterator
using	reverse_iterator
using	const_reverse_iterator

Detailed Description

Definition at line 45 of file namespacedef.h.

Member Function Documentation

declVisible()

bool NamespaceLinkedRefMap::declVisible

(

bool

isContantGroup

)

const

Definition at line 1434 of file namespacedef.cpp.

{
  bool found=false;
  for (const auto &nd : *this)
  {
    if (nd->isLinkable() && nd->hasDocumentation())
    {
      SrcLangExt lang = nd->getLanguage();
      if (SrcLangExt::IDL==lang)
      {
        if (isConstantGroup == nd->isConstantGroup())
        {
          found=true;
          break;
        }
      }
      else if (!isConstantGroup) // ensure we only get extra section in IDL
      {
        if (nd->isConstantGroup())
        {
          err("Internal inconsistency: constant group but not IDL?\n");
        }
        found=true;
        break;
      }
    }
  }
  return found;
}

References err.

Referenced by writeDeclaration(), FileDefImpl::writeSummaryLinks(), GroupDefImpl::writeSummaryLinks(), and NamespaceDefImpl::writeSummaryLinks().

writeDeclaration()

void NamespaceLinkedRefMap::writeDeclaration	(	OutputList &	ol,
		const DString &	title,
		bool	isConstantGroup = false,
		bool	localName = false )

Definition at line 1464 of file namespacedef.cpp.

{
 
 
  if (empty()) return; // no namespaces in the list
 
  if (Config_getBool(OPTIMIZE_OUTPUT_VHDL)) return;
 
  if (!declVisible(isConstantGroup)) return;
 
  // write list of namespaces
  ol.startMemberHeader(isConstantGroup ? "constantgroups" : "namespaces");
  //bool javaOpt    = Config_getBool(OPTIMIZE_OUTPUT_JAVA);
  //bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
  ol.parseText(title);
  ol.endMemberHeader();
  ol.startMemberList();
  for (const auto &nd : *this)
  {
    if (nd->isLinkable() && nd->hasDocumentation())
    {
      SrcLangExt lang = nd->getLanguage();
      if (lang==SrcLangExt::IDL && (isConstantGroup != nd->isConstantGroup()))
          continue; // will be output in another pass, see layout_default.xml
      ol.startMemberDeclaration();
      DString name = localName ? nd->localName() : nd->displayName();
      DString anc = nd->anchor();
      if (anc.empty()) anc=name; else anc.prepend(name+"_");
      ol.startMemberItem(anc,OutputGenerator::MemberItemType::Normal);
      DString ct = nd->compoundTypeString();
      ol.docify(ct);
      ol.docify(" ");
      ol.insertMemberAlign();
      ol.writeObjectLink(nd->getReference(),nd->getOutputFileBase(),DString(),name);
      ol.endMemberItem(OutputGenerator::MemberItemType::Normal);
      if (!nd->briefDescription().empty() && Config_getBool(BRIEF_MEMBER_DESC))
      {
        ol.startMemberDescription(nd->getOutputFileBase());
        ol.generateDoc(nd->briefFile(),
                       nd->briefLine(),
                       nd,
                       nullptr,
                       nd->briefDescription(),
                       DocOptions()
                       .setSingleLine(true));
        ol.endMemberDescription();
      }
      ol.endMemberDeclaration(DString(),DString());
    }
  }
  ol.endMemberList();
}

References Config_getBool, declVisible(), OutputList::docify(), DString::empty(), LinkedRefMap< const NamespaceDef >::empty(), OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), OutputList::endMemberList(), OutputList::generateDoc(), OutputList::insertMemberAlign(), OutputGenerator::Normal, OutputList::parseText(), DString::prepend(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), OutputList::startMemberList(), and OutputList::writeObjectLink().

Referenced by FileDefImpl::writeNamespaceDeclarations(), NamespaceDefImpl::writeNamespaceDeclarations(), and GroupDefImpl::writeNamespaces().

---

The documentation for this class was generated from the following files:

• src/namespacedef.h
• src/namespacedef.cpp