Inheritance diagram for ConceptDefImpl:

Collaboration diagram for ConceptDefImpl:

Public Member Functions
	ConceptDefImpl (const DString &fileName, int startLine, int startColumn, const DString &name, const DString &tagRef=DString(), const DString &tagFile=DString())
	~ConceptDefImpl () override
DefType	definitionType () const override
CodeSymbolType	codeSymbolType () const override
DString	getOutputFileBase () const override
bool	hasDetailedDescription () const override
DString	displayName (bool includeScope=true) const override
const IncludeInfo *	includeInfo () const override
ArgumentList	getTemplateParameterList () const override
DString	anchor () const override
bool	isLinkableInProject () const override
bool	isLinkable () const override
DString	initializer () const override
void	writeDeclarationLink (OutputList &ol, bool &found, const DString &header, bool localNames) const override
const NamespaceDef *	getNamespaceDef () const override
const FileDef *	getFileDef () const override
const ModuleDef *	getModuleDef () const override
DString	title () const override
int	groupId () const override
Parts	conceptParts () const override
void	setIncludeFile (FileDef *fd, const DString &incName, bool local, bool force) override
void	setTemplateArguments (const ArgumentList &al) override
void	setNamespace (NamespaceDef *nd) override
void	setFileDef (FileDef *fd) override
void	setModuleDef (ModuleDef *mod) override
void	writeTagFile (TextStream &) override
void	writeDocumentation (OutputList &) override
void	setInitializer (const DString &init) override
void	findSectionsInDocumentation () override
void	setGroupId (int id) override
void	addDocPart (const DString &doc, int lineNr, int colNr) override
void	addCodePart (const DString &code, int lineNr, int colNr) override
void	addListReferences () override
void	addRequirementReferences () override
void	writeBriefDescription (OutputList &) const
void	writeAuthorSection (OutputList &ol) const
void	writeIncludeFiles (OutputList &ol) const
void	writeDetailedDescription (OutputList &ol, const DString &title) const
void	writeDefinition (OutputList &ol, const DString &title) const
void	addConceptAttributes (OutputList &ol) const
Public Member Functions inherited from DefinitionMixin< ConceptDefMutable >
	DefinitionMixin (const DString &defFileName, int defLine, int defColumn, const DString &name, const char b=nullptr, const char d=nullptr, bool isSymbol=true)
DefinitionMixin &	operator= (const DefinitionMixin &other)
	~DefinitionMixin () override=default
bool	isAlias () const override
const DString &	name () const override
bool	isAnonymous () const override
const DString &	localName () const override
DString	qualifiedName () const override
DString	symbolName () const override
DString	getSourceFileBase () const override
DString	getSourceAnchor () const override
DString	documentation () const override
int	docLine () const override
DString	docFile () const override
DString	briefDescription (bool abbreviate=false) const override
DString	briefDescriptionAsTooltip () const override
int	briefLine () const override
DString	inbodyDocumentation () const override
DString	inbodyFile () const override
int	inbodyLine () const override
DString	briefFile () const override
DString	getDefFileName () const override
DString	getDefFileExtension () const override
int	getDefLine () const override
int	getDefColumn () const override
bool	hasDocumentation () const override
bool	hasUserDocumentation () const override
bool	isVisibleInProject () const override
bool	isVisible () const override
bool	isHidden () const override
bool	isArtificial () const override
bool	isExported () const override
DString	getReference () const override
bool	isReference () const override
DString	externalReference (const DString &relPath) const override
int	getStartDefLine () const override
int	getStartBodyLine () const override
int	getEndBodyLine () const override
const FileDef *	getBodyDef () const override
SrcLangExt	getLanguage () const override
const GroupList &	partOfGroups () const override
bool	isLinkableViaGroup () const override
const RefItemVector &	xrefListItems () const override
const RequirementRefs &	requirementReferences () const override
const Definition *	findInnerCompound (const DString &name) const override
Definition *	getOuterScope () const override
const MemberVector &	getReferencesMembers () const override
const MemberVector &	getReferencedByMembers () const override
bool	hasSections () const override
bool	hasSources () const override
bool	hasBriefDescription () const override
DString	id () const override
const SectionRefs &	getSectionRefs () const override
void	setName (const DString &name) override
void	setId (const DString &name) override
void	setDefFile (const DString &df, int defLine, int defColumn) override
void	setDocumentation (const DString &doc, const DString &docFile, int docLine, bool stripWhiteSpace=true) override
void	setBriefDescription (const DString &brief, const DString &briefFile, int briefLine) override
void	setInbodyDocumentation (const DString &doc, const DString &docFile, int docLine) override
void	setReference (const DString &r) override
void	addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList) override
void	setBodySegment (int defLine, int bls, int ble) override
void	setBodyDef (const FileDef *fd) override
void	addSourceReferencedBy (MemberDef *md, const DString &sourceRefName) override
void	addSourceReferences (MemberDef *md, const DString &sourceRefName) override
void	setRefItems (const RefItemVector &sli) override
void	setRequirementReferences (const RequirementRefs &rqli) override
void	mergeRefItems (Definition *def) override
void	mergeReferences (const Definition *other) override
void	mergeReferencedBy (const Definition *other) override
void	addInnerCompound (Definition *def) override
void	setOuterScope (Definition *def) override
void	setHidden (bool b) override
void	setArtificial (bool b) override
void	setExported (bool b) override
void	setLanguage (SrcLangExt lang) override
void	writeSourceDef (OutputList &ol) const override
void	writeInlineCode (OutputList &ol, const DString &scopeName) const override
bool	hasSourceRefs () const override
bool	hasSourceReffedBy () const override
void	writeSourceRefs (OutputList &ol, const DString &scopeName) const override
void	writeSourceReffedBy (OutputList &ol, const DString &scopeName) const override
bool	hasRequirementRefs () const override
void	writeRequirementRefs (OutputList &ol) const override
void	makePartOfGroup (GroupDef *gd) override
void	writeNavigationPath (OutputList &ol) const override
DString	navigationPathAsString () const override
void	writeQuickMemberLinks (OutputList &ol, const MemberDef *md) const override
void	writeSummaryLinks (OutputList &ol) const override
void	writePageNavigation (OutputList &ol) const override
DString	pathFragment () const override
void	writeDocAnchorsToTagFile (TextStream &fs) const override
void	setLocalName (const DString &name) override
void	writeToc (OutputList &ol, const LocalToc &lt) const override
void	computeTooltip () override
void	_setSymbolName (const DString &name) override
DString	_symbolName () const override

Private Attributes
DString	m_fileName
std::unique_ptr< IncludeInfo >	m_incInfo
NamespaceDef *	m_nspace = nullptr
FileDef *	m_fileDef = nullptr
ModuleDef *	m_moduleDef = nullptr
ArgumentList	m_tArgList
DString	m_initializer
int	m_groupId = -1
Parts	m_parts

Additional Inherited Members
Public Types inherited from ConceptDef
enum class	PartType { Code , Doc }
using	Parts = std::vector<Part>
Public Types inherited from Definition
enum	DefType { TypeClass = 0 , TypeFile = 1 , TypeNamespace = 2 , TypeModule = 3 , TypeMember = 4 , TypeGroup = 5 , TypePackage = 6 , TypePage = 7 , TypeDir = 8 , TypeConcept = 9 }

Detailed Description

Definition at line 31 of file conceptdef.cpp.

Constructor & Destructor Documentation

◆ ConceptDefImpl()

ConceptDefImpl::ConceptDefImpl	(	const DString &	fileName,
		int	startLine,
		int	startColumn,
		const DString &	name,
		const DString &	tagRef = DString(),
		const DString &	tagFile = DString() )

Definition at line 164 of file conceptdef.cpp.

                                                                      : DefinitionMixin(fileName,startLine,startColumn,name)
{
  if (!tagFile.empty())
  {
    if (!tagRef.empty())
    {
      m_fileName = stripExtension(tagFile);
    }
    else
    {
      m_fileName = convertNameToFile(stripExtension(tagFile));
    }
  }
  else
  {
    m_fileName = convertNameToFile(DString("concept")+name);
  }
  setReference(tagRef);
}

References DefinitionMixin< ConceptDefMutable >::DefinitionMixin(), DString::empty(), and DefinitionMixin< ConceptDefMutable >::name().

◆ ~ConceptDefImpl()

ConceptDefImpl::~ConceptDefImpl ( )

override

Definition at line 185 of file conceptdef.cpp.

186{

187}

Member Function Documentation

◆ addCodePart()

void ConceptDefImpl::addCodePart	(	const DString &	code,
		int	lineNr,
		int	colNr )

overridevirtual

Implements ConceptDefMutable.

Definition at line 785 of file conceptdef.cpp.

{
  m_parts.emplace_back(PartType::Code,code,lineNr,colNr);
}

References ConceptDef::Code, and m_parts.

◆ addConceptAttributes()

void ConceptDefImpl::addConceptAttributes ( OutputList & ol ) const

Definition at line 575 of file conceptdef.cpp.

{
  if (isExported())
  {
    ol.pushGeneratorState();
    ol.disableAllBut(OutputType::Html);
    ol.startLabels();
    ol.writeLabel("export",false);
    ol.endLabels();
    ol.popGeneratorState();
  }
}

References OutputList::disableAllBut(), OutputList::endLabels(), Html, DefinitionMixin< ConceptDefMutable >::isExported(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startLabels(), and OutputList::writeLabel().

Referenced by writeDocumentation().

◆ addDocPart()

void ConceptDefImpl::addDocPart	(	const DString &	doc,
		int	lineNr,
		int	colNr )

overridevirtual

Implements ConceptDefMutable.

Definition at line 780 of file conceptdef.cpp.

{
  m_parts.emplace_back(PartType::Doc,doc,lineNr,colNr);
}

References ConceptDef::Doc, and m_parts.

◆ addListReferences()

void ConceptDefImpl::addListReferences ( )

overridevirtual

Implements ConceptDefMutable.

Definition at line 317 of file conceptdef.cpp.

{
  addRefItem(xrefListItems(),
             qualifiedName(),
             theTranslator->trConcept(true,true),
             getOutputFileBase(),
             displayName(),
             DString(),
             this
            );
}

References addRefItem(), displayName(), DString::DString(), getOutputFileBase(), DefinitionMixin< ConceptDefMutable >::qualifiedName(), theTranslator, Translator::trConcept(), and DefinitionMixin< ConceptDefMutable >::xrefListItems().

◆ addRequirementReferences()

void ConceptDefImpl::addRequirementReferences ( )

overridevirtual

Implements ConceptDefMutable.

Definition at line 329 of file conceptdef.cpp.

{
  RequirementManager::instance().addRequirementRefsForSymbol(this);
}

References RequirementManager::addRequirementRefsForSymbol(), and RequirementManager::instance().

◆ anchor()

DString ConceptDefImpl::anchor ( ) const

overridevirtual

Returns the anchor within a page where this item can be found

Implements Definition.

Definition at line 209 of file conceptdef.cpp.

{
  return "";
}

Referenced by writeDeclarationLink().

◆ codeSymbolType()

CodeSymbolType ConceptDefImpl::codeSymbolType ( ) const

inlineoverridevirtual

Used for syntax highlighting symbol class

Implements Definition.

Definition at line 41 of file conceptdef.cpp.

41{ return CodeSymbolType::Concept; }

CodeSymbolType::Concept

@ Concept

Definition types.h:494

References Concept.

◆ conceptParts()

Parts ConceptDefImpl::conceptParts ( ) const

inlineoverridevirtual

Implements ConceptDef.

Definition at line 58 of file conceptdef.cpp.

58{ return m_parts; }

References m_parts.

◆ definitionType()

Definition::DefType ConceptDefImpl::definitionType ( ) const

overridevirtual

Use this for dynamic inspection of the type of the derived class

Implements Definition.

Definition at line 189 of file conceptdef.cpp.

{
  return TypeConcept;
}

References Definition::TypeConcept.

◆ displayName()

DString ConceptDefImpl::displayName ( bool includeScope = true ) const

overridevirtual

Returns the name of the definition as it appears in the output

Implements Definition.

Definition at line 214 of file conceptdef.cpp.

{
  return includeScope ? name() : localName();
}

References DefinitionMixin< ConceptDefMutable >::localName(), and DefinitionMixin< ConceptDefMutable >::name().

Referenced by addListReferences(), title(), writeDeclarationLink(), and writeDocumentation().

◆ findSectionsInDocumentation()

void ConceptDefImpl::findSectionsInDocumentation ( )

overridevirtual

Implements ConceptDefMutable.

Definition at line 773 of file conceptdef.cpp.

{
  docFindSections(briefDescription(),this,docFile());
  docFindSections(documentation(),this,docFile());
  docFindSections(inbodyDocumentation(),this,docFile());
}

References DefinitionMixin< ConceptDefMutable >::briefDescription(), DefinitionMixin< ConceptDefMutable >::docFile(), docFindSections(), DefinitionMixin< ConceptDefMutable >::documentation(), and DefinitionMixin< ConceptDefMutable >::inbodyDocumentation().

◆ getFileDef()

const FileDef * ConceptDefImpl::getFileDef ( ) const

overridevirtual

Implements ConceptDef.

Definition at line 285 of file conceptdef.cpp.

{
  return m_fileDef;
}

References m_fileDef.

◆ getModuleDef()

const ModuleDef * ConceptDefImpl::getModuleDef ( ) const

overridevirtual

Implements ConceptDef.

Definition at line 290 of file conceptdef.cpp.

{
  return m_moduleDef;
}

References m_moduleDef.

◆ getNamespaceDef()

const NamespaceDef * ConceptDefImpl::getNamespaceDef ( ) const

overridevirtual

Implements ConceptDef.

Definition at line 270 of file conceptdef.cpp.

{
  return m_nspace;
}

References m_nspace.

◆ getOutputFileBase()

DString ConceptDefImpl::getOutputFileBase ( ) const

overridevirtual

Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.

Implements Definition.

Definition at line 194 of file conceptdef.cpp.

{
  return m_fileName;
}

References m_fileName.

Referenced by addListReferences(), writeBriefDescription(), writeDeclarationLink(), writeDocumentation(), and writeTagFile().

◆ getTemplateParameterList()

ArgumentList ConceptDefImpl::getTemplateParameterList ( ) const

overridevirtual

Implements ConceptDef.

Definition at line 224 of file conceptdef.cpp.

{
  return m_tArgList;
}

References m_tArgList.

◆ groupId()

int ConceptDefImpl::groupId ( ) const

overridevirtual

Implements ConceptDef.

Definition at line 307 of file conceptdef.cpp.

{
  return m_groupId;
}

References m_groupId.

◆ hasDetailedDescription()

bool ConceptDefImpl::hasDetailedDescription ( ) const

overridevirtual

Implements ConceptDef.

Definition at line 199 of file conceptdef.cpp.

{
  bool repeatBrief = Config_getBool(REPEAT_BRIEF);
  bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
  return ((!briefDescription().empty() && repeatBrief) ||
          !documentation().empty() ||
          (sourceBrowser && getStartBodyLine()!=-1 && getBodyDef())) ||
          hasRequirementRefs();
}

References DefinitionMixin< ConceptDefMutable >::briefDescription(), Config_getBool, DefinitionMixin< ConceptDefMutable >::documentation(), DefinitionMixin< ConceptDefMutable >::getBodyDef(), DefinitionMixin< ConceptDefMutable >::getStartBodyLine(), and DefinitionMixin< ConceptDefMutable >::hasRequirementRefs().

Referenced by writeBriefDescription(), and writeDetailedDescription().

◆ includeInfo()

const IncludeInfo * ConceptDefImpl::includeInfo ( ) const

overridevirtual

Implements ConceptDef.

Definition at line 219 of file conceptdef.cpp.

{
  return m_incInfo.get();
}

References m_incInfo.

◆ initializer()

DString ConceptDefImpl::initializer ( ) const

overridevirtual

Implements ConceptDef.

Definition at line 456 of file conceptdef.cpp.

{
  return m_initializer;
}

References m_initializer.

◆ isLinkable()

bool ConceptDefImpl::isLinkable ( ) const

overridevirtual

Returns true iff it is possible to link to this item. This can be a link to another project imported via a tag file.

Implements Definition.

Definition at line 237 of file conceptdef.cpp.

{
  return isLinkableInProject() || isReference();
}

References isLinkableInProject(), and DefinitionMixin< ConceptDefMutable >::isReference().

Referenced by writeDeclarationLink().

◆ isLinkableInProject()

bool ConceptDefImpl::isLinkableInProject ( ) const

overridevirtual

Returns true iff it is possible to link to this item within this project.

Implements Definition.

Definition at line 229 of file conceptdef.cpp.

{
  bool hideUndoc = Config_getBool(HIDE_UNDOC_CLASSES);
  return (hasDocumentation() || !hideUndoc) && /* documented */
         !isHidden() &&                        /* not hidden */
         !isReference();                       /* not an external reference */
}

References Config_getBool, DefinitionMixin< ConceptDefMutable >::hasDocumentation(), DefinitionMixin< ConceptDefMutable >::isHidden(), and DefinitionMixin< ConceptDefMutable >::isReference().

Referenced by isLinkable().

◆ setFileDef()

void ConceptDefImpl::setFileDef ( FileDef * fd )

overridevirtual

Implements ConceptDefMutable.

Definition at line 275 of file conceptdef.cpp.

{
  m_fileDef=fd;
}

References m_fileDef.

Referenced by writeDefinition().

◆ setGroupId()

void ConceptDefImpl::setGroupId ( int id )

overridevirtual

Implements ConceptDefMutable.

Definition at line 312 of file conceptdef.cpp.

{
  m_groupId = id;
}

References DefinitionMixin< ConceptDefMutable >::id(), and m_groupId.

◆ setIncludeFile()

void ConceptDefImpl::setIncludeFile	(	FileDef *	fd,
		const DString &	incName,
		bool	local,
		bool	force )

overridevirtual

Implements ConceptDefMutable.

Definition at line 242 of file conceptdef.cpp.

{
  if (!m_incInfo) m_incInfo = std::make_unique<IncludeInfo>();
  if ((!incName.empty() && m_incInfo->includeName.empty()) ||
      (fd!=nullptr && m_incInfo->fileDef==nullptr)
     )
  {
    m_incInfo->fileDef     = fd;
    m_incInfo->includeName = incName;
    m_incInfo->kind        = local ? IncludeKind::IncludeLocal : IncludeKind::IncludeSystem;
  }
  if (force && !incName.empty())
  {
    m_incInfo->includeName = incName;
    m_incInfo->kind        = local ? IncludeKind::IncludeLocal : IncludeKind::IncludeSystem;
  }
}

References DString::empty(), IncludeLocal, IncludeSystem, and m_incInfo.

◆ setInitializer()

void ConceptDefImpl::setInitializer ( const DString & init )

overridevirtual

Implements ConceptDefMutable.

Definition at line 451 of file conceptdef.cpp.

{
  m_initializer = templateSpec(m_tArgList)+"\nconcept "+name()+" = "+init;
}

References m_initializer, m_tArgList, DefinitionMixin< ConceptDefMutable >::name(), and templateSpec().

◆ setModuleDef()

void ConceptDefImpl::setModuleDef ( ModuleDef * mod )

overridevirtual

Implements ConceptDefMutable.

Definition at line 280 of file conceptdef.cpp.

{
  m_moduleDef=mod;
}

References m_moduleDef.

◆ setNamespace()

void ConceptDefImpl::setNamespace ( NamespaceDef * nd )

overridevirtual

Implements ConceptDefMutable.

Definition at line 265 of file conceptdef.cpp.

{
  m_nspace = nd;
}

References m_nspace.

◆ setTemplateArguments()

void ConceptDefImpl::setTemplateArguments ( const ArgumentList & al )

overridevirtual

Implements ConceptDefMutable.

Definition at line 260 of file conceptdef.cpp.

{
  m_tArgList = al;
}

References m_tArgList.

◆ title()

DString ConceptDefImpl::title ( ) const

overridevirtual

Implements ConceptDef.

Definition at line 295 of file conceptdef.cpp.

{
  if (Config_getBool(HIDE_COMPOUND_REFERENCE))
  {
    return displayName();
  }
  else
  {
    return theTranslator->trConceptReference(displayName());
  }
}

References Config_getBool, displayName(), theTranslator, and Translator::trConceptReference().

Referenced by writeDefinition(), and writeDetailedDescription().

◆ writeAuthorSection()

void ConceptDefImpl::writeAuthorSection ( OutputList & ol ) const

Definition at line 563 of file conceptdef.cpp.

{
  // write Author section (Man only)
  ol.pushGeneratorState();
  ol.disableAllBut(OutputType::Man);
  ol.startGroupHeader();
  ol.parseText(theTranslator->trAuthor(true,true));
  ol.endGroupHeader();
  ol.parseText(theTranslator->trGeneratedAutomatically(Config_getString(PROJECT_NAME)));
  ol.popGeneratorState();
}

References Config_getString, OutputList::disableAllBut(), OutputList::endGroupHeader(), Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startGroupHeader(), theTranslator, Translator::trAuthor(), and Translator::trGeneratedAutomatically().

Referenced by writeDocumentation().

◆ writeBriefDescription()

void ConceptDefImpl::writeBriefDescription ( OutputList & ol ) const

Definition at line 350 of file conceptdef.cpp.

{
  if (hasBriefDescription())
  {
    auto parser { createDocParser() };
    auto ast    { validatingParseDoc(*parser.get(),
                                     briefFile(),
                                     briefLine(),
                                     this,
                                     nullptr,
                                     briefDescription(),
                                     DocOptions()
                                     .setIndexWords(true)
                                     .setSingleLine(true))
                };
    if (!ast->empty())
    {
      ol.startParagraph();
      ol.pushGeneratorState();
      ol.disableAllBut(OutputType::Man);
      ol.writeString(" - ");
      ol.popGeneratorState();
      ol.writeDoc(ast.get(),this,nullptr);
      ol.pushGeneratorState();
      ol.disable(OutputType::RTF);
      ol.writeString(" \n");
      ol.enable(OutputType::RTF);
 
      if (hasDetailedDescription())
      {
        ol.disableAllBut(OutputType::Html);
        ol.startTextLink(getOutputFileBase(),"details");
        ol.parseText(theTranslator->trMore());
        ol.endTextLink();
      }
      ol.popGeneratorState();
      ol.endParagraph();
    }
  }
  ol.writeSynopsis();
}

References DefinitionMixin< ConceptDefMutable >::briefDescription(), DefinitionMixin< ConceptDefMutable >::briefFile(), DefinitionMixin< ConceptDefMutable >::briefLine(), createDocParser(), OutputList::disable(), OutputList::disableAllBut(), OutputList::enable(), OutputList::endParagraph(), OutputList::endTextLink(), getOutputFileBase(), DefinitionMixin< ConceptDefMutable >::hasBriefDescription(), hasDetailedDescription(), Html, Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), RTF, OutputList::startParagraph(), OutputList::startTextLink(), theTranslator, Translator::trMore(), validatingParseDoc(), OutputList::writeDoc(), OutputList::writeString(), and OutputList::writeSynopsis().

Referenced by writeDocumentation().

◆ writeDeclarationLink()

void ConceptDefImpl::writeDeclarationLink	(	OutputList &	ol,
		bool &	found,
		const DString &	header,
		bool	localNames ) const

overridevirtual

Implements ConceptDef.

Definition at line 708 of file conceptdef.cpp.

{
  if (isLinkable())
  {
    if (!found) // first concept
    {
      ol.startMemberHeader("concepts");
      if (!header.empty())
      {
        ol.parseText(header);
      }
      else
      {
        theTranslator->trConcept(true,false);
      }
      ol.endMemberHeader();
      ol.startMemberList();
      found=true;
    }
    ol.startMemberDeclaration();
    DString cname = displayName(!localNames);
    DString anc=anchor();
    if (anc.empty()) anc=cname; else anc.prepend(cname+"_");
    ol.startMemberItem(anc,OutputGenerator::MemberItemType::Normal);
    ol.writeString("concept ");
    ol.insertMemberAlign();
    if (isLinkable())
    {
      ol.writeObjectLink(getReference(),
          getOutputFileBase(),
          anchor(),
          cname
          );
    }
    else
    {
      ol.startBold();
      ol.docify(cname);
      ol.endBold();
    }
    ol.endMemberItem(OutputGenerator::MemberItemType::Normal);
    // add the brief description if available
    if (!briefDescription().empty() && Config_getBool(BRIEF_MEMBER_DESC))
    {
      auto parser { createDocParser() };
      auto ast    { validatingParseDoc(*parser.get(),
                                       briefFile(),
                                       briefLine(),
                                       this,
                                       nullptr,
                                       briefDescription(),
                                       DocOptions()
                                       .setSingleLine(true))
                  };
      if (!ast->empty())
      {
        ol.startMemberDescription(anchor());
        ol.writeDoc(ast.get(),this,nullptr);
        ol.endMemberDescription();
      }
    }
    ol.endMemberDeclaration(anchor(),DString());
  }
}

References anchor(), DefinitionMixin< ConceptDefMutable >::briefDescription(), DefinitionMixin< ConceptDefMutable >::briefFile(), DefinitionMixin< ConceptDefMutable >::briefLine(), Config_getBool, createDocParser(), displayName(), OutputList::docify(), DString::DString(), DString::empty(), OutputList::endBold(), OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), getOutputFileBase(), DefinitionMixin< ConceptDefMutable >::getReference(), OutputList::insertMemberAlign(), isLinkable(), OutputGenerator::Normal, OutputList::parseText(), DString::prepend(), OutputList::startBold(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), OutputList::startMemberList(), theTranslator, Translator::trConcept(), validatingParseDoc(), OutputList::writeDoc(), OutputList::writeObjectLink(), and OutputList::writeString().

◆ writeDefinition()

void ConceptDefImpl::writeDefinition	(	OutputList &	ol,
		const DString &	title ) const

Definition at line 461 of file conceptdef.cpp.

{
    ol.startGroupHeader("conceptdef");
      ol.parseText(title);
    ol.endGroupHeader();
 
    auto intf = Doxygen::parserManager->getCodeParser(".cpp");
    intf->resetCodeParserState();
    auto &codeOL = ol.codeGenerators();
    for (const auto &part : m_parts)
    {
      if (part.type==PartType::Code)
      {
        codeOL.startCodeFragment("DoxyCode");
        DString scopeName;
        if (getOuterScope()!=Doxygen::globalScope) scopeName=getOuterScope()->name();
        //printf("concept=[%s]\n",qPrint(m_initializer));
        intf->parseCode(codeOL,
            scopeName,
            part.content,
            SrcLangExt::Cpp,
            false,      // stripCodeComments
            CodeParserOptions()
            .setFileDef(m_fileDef)
            .setInlineFragment(true)
            .setShowLineNumbers(false)
            .setSearchCtx(this)
            );
        codeOL.endCodeFragment("DoxyCode");
      }
      else if (part.type==PartType::Doc)
      {
        //printf("rendering part [[%s]] at %d\n",qPrint(part.content),part.lineNr);
        ol.startEmbeddedDoc(part.colNr);
        ol.generateDoc(getDefFileName(),
                       part.lineNr,
                       this,
                       nullptr,
                       part.content,
                       DocOptions());
        ol.endEmbeddedDoc();
      }
    }
}

References ConceptDef::Code, OutputList::codeGenerators(), ConceptDef::Doc, OutputList::endEmbeddedDoc(), OutputList::endGroupHeader(), OutputList::generateDoc(), ParserManager::getCodeParser(), DefinitionMixin< ConceptDefMutable >::getDefFileName(), DefinitionMixin< ConceptDefMutable >::getOuterScope(), Doxygen::globalScope, m_fileDef, m_parts, Definition::name(), Doxygen::parserManager, OutputList::parseText(), setFileDef(), OutputList::startEmbeddedDoc(), OutputList::startGroupHeader(), and title().

Referenced by writeDocumentation().

◆ writeDetailedDescription()

void ConceptDefImpl::writeDetailedDescription	(	OutputList &	ol,
		const DString &	title ) const

Definition at line 506 of file conceptdef.cpp.

{
  bool repeatBrief = Config_getBool(REPEAT_BRIEF);
  if (hasDetailedDescription())
  {
    ol.pushGeneratorState();
      ol.disable(OutputType::Html);
      ol.writeRuler();
    ol.popGeneratorState();
 
    ol.pushGeneratorState();
      ol.disableAllBut(OutputType::Html);
      ol.writeAnchor(DString(),"details");
    ol.popGeneratorState();
 
    ol.startGroupHeader("details");
      ol.parseText(title);
    ol.endGroupHeader();
 
    ol.startTextBlock();
    // repeat brief description
    if (!briefDescription().empty() && repeatBrief)
    {
      ol.generateDoc(briefFile(),
                     briefLine(),
                     this,
                     nullptr,
                     briefDescription(),
                     DocOptions());
    }
    if (!briefDescription().empty() && repeatBrief &&
        !documentation().empty())
    {
      ol.pushGeneratorState();
      ol.disable(OutputType::Html);
      ol.writeString("\n\n");
      ol.popGeneratorState();
    }
 
    // write documentation
    if (!documentation().empty())
    {
      ol.generateDoc(docFile(),
                     docLine(),
                     this,
                     nullptr,
                     documentation(),
                     DocOptions()
                     .setIndexWords(true));
    }
 
    writeSourceDef(ol);
    if (hasRequirementRefs()) writeRequirementRefs(ol);
    ol.endTextBlock();
  }
}

Referenced by writeDocumentation().

◆ writeDocumentation()

void ConceptDefImpl::writeDocumentation ( OutputList & ol )

overridevirtual

Implements ConceptDefMutable.

Definition at line 588 of file conceptdef.cpp.

{
  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  DString pageTitle;
  if (Config_getBool(HIDE_COMPOUND_REFERENCE))
  {
    pageTitle = displayName();
  }
  else
  {
    pageTitle = theTranslator->trConceptReference(displayName());
  }
  startFile(ol,getOutputFileBase(),false,name(),pageTitle,HighlightedItem::ConceptVisible,!generateTreeView);
 
  // ---- navigation part
  if (!generateTreeView)
  {
    if (getOuterScope()!=Doxygen::globalScope)
    {
      writeNavigationPath(ol);
    }
    ol.endQuickIndices();
  }
 
  // ---- title part
  startTitle(ol,getOutputFileBase(),this);
  ol.parseText(pageTitle);
  addConceptAttributes(ol);
  addGroupListToTitle(ol,this);
  endTitle(ol,getOutputFileBase(),displayName());
 
  // ---- contents part
 
  ol.startContents();
 
  //---------------------------------------- start flexible part -------------------------------
 
  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Concept))
  {
    const LayoutDocEntrySection *ls = dynamic_cast<const LayoutDocEntrySection*>(lde.get());
    switch (lde->kind())
    {
      case LayoutDocEntry::BriefDesc:
        writeBriefDescription(ol);
        break;
      case LayoutDocEntry::ConceptDefinition:
        if (ls) writeDefinition(ol,ls->title(getLanguage()));
        break;
      case LayoutDocEntry::DetailedDesc:
        if (ls) writeDetailedDescription(ol,ls->title(getLanguage()));
        break;
      case LayoutDocEntry::AuthorSection:
        writeAuthorSection(ol);
        break;
      case LayoutDocEntry::ClassIncludes:
        writeIncludeFiles(ol);
        break;
      case LayoutDocEntry::MemberDeclStart:
      case LayoutDocEntry::NamespaceClasses:
      case LayoutDocEntry::NamespaceInterfaces:
      case LayoutDocEntry::NamespaceStructs:
      case LayoutDocEntry::NamespaceExceptions:
      case LayoutDocEntry::NamespaceConcepts:
      case LayoutDocEntry::NamespaceNestedNamespaces:
      case LayoutDocEntry::NamespaceNestedConstantGroups:
      case LayoutDocEntry::MemberGroups:
      case LayoutDocEntry::MemberDecl:
      case LayoutDocEntry::MemberDeclEnd:
      case LayoutDocEntry::MemberDefStart:
      case LayoutDocEntry::NamespaceInlineClasses:
      case LayoutDocEntry::MemberDef:
      case LayoutDocEntry::MemberDefEnd:
      case LayoutDocEntry::ClassInheritanceGraph:
      case LayoutDocEntry::ClassNestedClasses:
      case LayoutDocEntry::ClassCollaborationGraph:
      case LayoutDocEntry::ClassAllMembersLink:
      case LayoutDocEntry::ClassUsedFiles:
      case LayoutDocEntry::ClassInlineClasses:
      case LayoutDocEntry::FileClasses:
      case LayoutDocEntry::FileConcepts:
      case LayoutDocEntry::FileInterfaces:
      case LayoutDocEntry::FileStructs:
      case LayoutDocEntry::FileExceptions:
      case LayoutDocEntry::FileNamespaces:
      case LayoutDocEntry::FileConstantGroups:
      case LayoutDocEntry::FileIncludes:
      case LayoutDocEntry::FileIncludeGraph:
      case LayoutDocEntry::FileIncludedByGraph:
      case LayoutDocEntry::FileInlineClasses:
      case LayoutDocEntry::FileSourceLink:
      case LayoutDocEntry::GroupClasses:
      case LayoutDocEntry::GroupConcepts:
      case LayoutDocEntry::GroupModules:
      case LayoutDocEntry::GroupInlineClasses:
      case LayoutDocEntry::GroupNamespaces:
      case LayoutDocEntry::GroupDirs:
      case LayoutDocEntry::GroupNestedGroups:
      case LayoutDocEntry::GroupFiles:
      case LayoutDocEntry::GroupGraph:
      case LayoutDocEntry::GroupPageDocs:
      case LayoutDocEntry::ModuleExports:
      case LayoutDocEntry::ModuleClasses:
      case LayoutDocEntry::ModuleConcepts:
      case LayoutDocEntry::ModuleUsedFiles:
      case LayoutDocEntry::DirSubDirs:
      case LayoutDocEntry::DirFiles:
      case LayoutDocEntry::DirGraph:
        err("Internal inconsistency: member '{}' should not be part of "
            "LayoutDocManager::Concept entry list\n",lde->entryToString());
        break;
    }
  }
 
  //---------------------------------------- end flexible part -------------------------------
 
  ol.endContents();
 
  endFileWithNavPath(ol,this);
}

References addConceptAttributes(), addGroupListToTitle(), ConceptVisible, Config_getBool, displayName(), OutputList::endContents(), endFileWithNavPath(), OutputList::endQuickIndices(), endTitle(), err, DefinitionMixin< ConceptDefMutable >::getLanguage(), DefinitionMixin< ConceptDefMutable >::getOuterScope(), getOutputFileBase(), Doxygen::globalScope, LayoutDocManager::instance(), DefinitionMixin< ConceptDefMutable >::name(), OutputList::parseText(), OutputList::startContents(), startFile(), startTitle(), theTranslator, LayoutDocEntrySection::title(), Translator::trConceptReference(), writeAuthorSection(), writeBriefDescription(), writeDefinition(), writeDetailedDescription(), writeIncludeFiles(), and DefinitionMixin< ConceptDefMutable >::writeNavigationPath().

◆ writeIncludeFiles()

void ConceptDefImpl::writeIncludeFiles ( OutputList & ol ) const

Definition at line 392 of file conceptdef.cpp.

{
  if (m_incInfo)
  {
    DString nm=m_incInfo->includeName.empty() ?
      (m_incInfo->fileDef ?
       m_incInfo->fileDef->docName() : DString()
      ) :
      m_incInfo->includeName;
    if (!nm.empty())
    {
      ol.startParagraph();
      ol.startTypewriter();
      ol.docify(::includeStatement(SrcLangExt::Cpp,m_incInfo->kind));
      ol.docify(::includeOpen(SrcLangExt::Cpp,m_incInfo->kind));
      ol.pushGeneratorState();
      ol.disable(OutputType::Html);
      ol.docify(nm);
      ol.disableAllBut(OutputType::Html);
      ol.enable(OutputType::Html);
      if (m_incInfo->fileDef)
      {
        ol.writeObjectLink(DString(),m_incInfo->fileDef->includeName(),DString(),nm);
      }
      else
      {
        ol.docify(nm);
      }
      ol.popGeneratorState();
      ol.docify(::includeClose(SrcLangExt::Cpp,m_incInfo->kind));
      ol.endTypewriter();
      ol.endParagraph();
    }
  }
}

References OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), DString::DString(), DString::empty(), OutputList::enable(), OutputList::endParagraph(), OutputList::endTypewriter(), Html, includeClose(), includeOpen(), includeStatement(), m_incInfo, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startParagraph(), OutputList::startTypewriter(), and OutputList::writeObjectLink().

Referenced by writeDocumentation().

◆ writeTagFile()

void ConceptDefImpl::writeTagFile ( TextStream & tagFile )

overridevirtual

Implements ConceptDefMutable.

Definition at line 334 of file conceptdef.cpp.

{
  tagFile << "  <compound kind=\"concept\">\n";
  tagFile << "    <name>" << convertToXML(name()) << "</name>\n";
  DString fn = getOutputFileBase();
  addHtmlExtensionIfMissing(fn);
  tagFile << "    <filename>" << convertToXML(fn) << "</filename>\n";
  DString idStr = id();
  if (!idStr.empty())
  {
    tagFile << "    <clangid>" << convertToXML(idStr) << "</clangid>\n";
  }
  writeDocAnchorsToTagFile(tagFile);
  tagFile << "  </compound>\n";
}

References addHtmlExtensionIfMissing(), convertToXML(), DString::empty(), getOutputFileBase(), DefinitionMixin< ConceptDefMutable >::id(), DefinitionMixin< ConceptDefMutable >::name(), and DefinitionMixin< ConceptDefMutable >::writeDocAnchorsToTagFile().

Member Data Documentation

◆ m_fileDef

FileDef* ConceptDefImpl::m_fileDef = nullptr

private

Definition at line 88 of file conceptdef.cpp.

Referenced by getFileDef(), setFileDef(), and writeDefinition().

◆ m_fileName

DString ConceptDefImpl::m_fileName

private

Definition at line 85 of file conceptdef.cpp.

Referenced by getOutputFileBase().

◆ m_groupId

int ConceptDefImpl::m_groupId = -1

private

Definition at line 92 of file conceptdef.cpp.

Referenced by groupId(), and setGroupId().

◆ m_incInfo

std::unique_ptr<IncludeInfo> ConceptDefImpl::m_incInfo

private

Definition at line 86 of file conceptdef.cpp.

Referenced by includeInfo(), setIncludeFile(), and writeIncludeFiles().

◆ m_initializer

DString ConceptDefImpl::m_initializer

private

Definition at line 91 of file conceptdef.cpp.

Referenced by initializer(), and setInitializer().

◆ m_moduleDef

ModuleDef* ConceptDefImpl::m_moduleDef = nullptr

private

Definition at line 89 of file conceptdef.cpp.

Referenced by getModuleDef(), and setModuleDef().

◆ m_nspace

NamespaceDef* ConceptDefImpl::m_nspace = nullptr

private

Definition at line 87 of file conceptdef.cpp.

Referenced by getNamespaceDef(), and setNamespace().

◆ m_parts

Parts ConceptDefImpl::m_parts

private

Definition at line 93 of file conceptdef.cpp.

Referenced by addCodePart(), addDocPart(), conceptParts(), and writeDefinition().

◆ m_tArgList

ArgumentList ConceptDefImpl::m_tArgList

private

Definition at line 90 of file conceptdef.cpp.

Referenced by getTemplateParameterList(), setInitializer(), and setTemplateArguments().

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

src/conceptdef.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ConceptDefImpl()

◆ ~ConceptDefImpl()

Member Function Documentation

◆ addCodePart()

◆ addConceptAttributes()

◆ addDocPart()

◆ addListReferences()

◆ addRequirementReferences()

◆ anchor()

◆ codeSymbolType()

◆ conceptParts()

◆ definitionType()

◆ displayName()

◆ findSectionsInDocumentation()

◆ getFileDef()

◆ getModuleDef()

◆ getNamespaceDef()

◆ getOutputFileBase()

◆ getTemplateParameterList()

◆ groupId()

◆ hasDetailedDescription()

◆ includeInfo()

◆ initializer()

◆ isLinkable()

◆ isLinkableInProject()

◆ setFileDef()

◆ setGroupId()

◆ setIncludeFile()

◆ setInitializer()

◆ setModuleDef()

◆ setNamespace()

◆ setTemplateArguments()

◆ title()

◆ writeAuthorSection()

◆ writeBriefDescription()

◆ writeDeclarationLink()

◆ writeDefinition()

◆ writeDetailedDescription()

◆ writeDocumentation()

◆ writeIncludeFiles()

◆ writeTagFile()

Member Data Documentation

◆ m_fileDef

◆ m_fileName

◆ m_groupId

◆ m_incInfo

◆ m_initializer

◆ m_moduleDef

◆ m_nspace

◆ m_parts

◆ m_tArgList