DirRelation Class Reference

A usage relation between two directories. More...

#include <src/dirdef.h>

Collaboration diagram for DirRelation:

Public Member Functions
	DirRelation (const DString &name, const DirDef *src, UsedDir *dst)
const DirDef *	source () const
UsedDir *	destination () const
void	writeDocumentation (OutputList &ol)
DString	getOutputFileBase () const

Private Attributes
DString	m_name
const DirDef *	m_src
UsedDir *	m_dst

Detailed Description

A usage relation between two directories.

Definition at line 157 of file dirdef.h.

Constructor & Destructor Documentation

DirRelation()

DirRelation::DirRelation ( const DString & name, const DirDef * src, UsedDir * dst )

inline

Definition at line 160 of file dirdef.h.

      : m_name(name), m_src(src), m_dst(dst) {}

References m_dst, m_name, and m_src.

Member Function Documentation

destination()

UsedDir * DirRelation::destination ( ) const

inline

Definition at line 163 of file dirdef.h.

{ return m_dst; }

References m_dst.

getOutputFileBase()

DString DirRelation::getOutputFileBase ( ) const

inline

Definition at line 165 of file dirdef.h.

{ return m_name; }

References m_name.

Referenced by writeDocumentation().

source()

const DirDef * DirRelation::source ( ) const

inline

Definition at line 162 of file dirdef.h.

{ return m_src; }

References m_src.

writeDocumentation()

void DirRelation::writeDocumentation

(

OutputList &

ol

)

Definition at line 983 of file dirdef.cpp.

{
  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  ol.pushGeneratorState();
  ol.disableAllBut(OutputType::Html);
 
  DString shortTitle=theTranslator->trDirRelation(
                      (m_src->shortName()+" → "+m_dst->dir()->shortName()));
  DString title=theTranslator->trDirRelation(
                 (m_src->displayName()+" -> "+m_dst->dir()->shortName()));
  AUTO_TRACE("title={}",title);
  startFile(ol,getOutputFileBase(),false,getOutputFileBase(),
            title,HighlightedItem::None,!generateTreeView,m_src->getOutputFileBase());
 
  if (!generateTreeView)
  {
    // write navigation path
    m_src->writeNavigationPath(ol);
    ol.endQuickIndices();
  }
  ol.startContents();
 
  ol.writeString("<h3>"+shortTitle+"</h3>");
  ol.writeString("<table class=\"dirtab\">");
  ol.writeString("<tr class=\"dirtab\">");
  ol.writeString("<th class=\"dirtab\">");
  ol.parseText(theTranslator->trFileIn(m_src->pathFragment()));
  ol.writeString("</th>");
  ol.writeString("<th class=\"dirtab\">");
  ol.parseText(theTranslator->trIncludesFileIn(m_dst->dir()->pathFragment()));
  ol.writeString("</th>");
  ol.writeString("</tr>");
 
  for (const auto &fp : m_dst->filePairs())
  {
    ol.writeString("<tr class=\"dirtab\">");
    ol.writeString("<td class=\"dirtab\">");
    writePartialFilePath(ol,m_src,fp->source());
    ol.writeString("</td>");
    ol.writeString("<td class=\"dirtab\">");
    writePartialFilePath(ol,m_dst->dir(),fp->destination());
    ol.writeString("</td>");
    ol.writeString("</tr>");
  }
  ol.writeString("</table>");
 
  ol.endContents();
 
  endFileWithNavPath(ol,m_src);
 
  ol.popGeneratorState();
}

References AUTO_TRACE, Config_getBool, UsedDir::dir(), OutputList::disableAllBut(), Definition::displayName(), OutputList::endContents(), endFileWithNavPath(), OutputList::endQuickIndices(), UsedDir::filePairs(), Definition::getOutputFileBase(), getOutputFileBase(), Html, m_dst, m_src, None, OutputList::parseText(), Definition::pathFragment(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), DirDef::shortName(), OutputList::startContents(), startFile(), theTranslator, Translator::trDirRelation(), Translator::trFileIn(), Translator::trIncludesFileIn(), DefinitionMutable::writeNavigationPath(), writePartialFilePath(), and OutputList::writeString().

Member Data Documentation

m_dst

UsedDir* DirRelation::m_dst

private

Definition at line 170 of file dirdef.h.

Referenced by destination(), DirRelation(), and writeDocumentation().

m_name

DString DirRelation::m_name

private

Definition at line 168 of file dirdef.h.

Referenced by DirRelation(), and getOutputFileBase().

m_src

const DirDef* DirRelation::m_src

private

Definition at line 169 of file dirdef.h.

Referenced by DirRelation(), source(), and writeDocumentation().

---

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

• src/dirdef.h
• src/dirdef.cpp