#include <latexgen.h>

类 LatexCodeGenerator 继承关系图:

LatexCodeGenerator 的协作图:

Public 成员函数
	LatexCodeGenerator (TextStream &t, const QCString &relPath, const QCString &sourceFile)

	LatexCodeGenerator (TextStream &t)

void	setRelativePath (const QCString &path)

void	setSourceFileName (const QCString &sourceFileName)

void	codify (const QCString &text) override

void	writeCodeLink (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip) override

void	writeTooltip (const QCString &, const DocLinkInfo &, const QCString &, const QCString &, const SourceLinkInfo &, const SourceLinkInfo &) override

void	writeLineNumber (const QCString &, const QCString &, const QCString &, int, bool) override

void	startCodeLine (bool) override

void	endCodeLine () override

void	startFontClass (const QCString &) override

void	endFontClass () override

void	writeCodeAnchor (const QCString &) override

void	setCurrentDoc (const Definition *, const QCString &, bool) override

void	addWord (const QCString &, bool) override

void	startCodeFragment (const QCString &style) override

void	endCodeFragment (const QCString &style) override

void	incUsedTableLevel ()

void	decUsedTableLevel ()

int	usedTableLevel () const

Public 成员函数继承自 CodeOutputInterface
virtual	~CodeOutputInterface ()

	CodeOutputInterface ()

	CodeOutputInterface (const CodeOutputInterface &)=delete

CodeOutputInterface &	operator= (const CodeOutputInterface &)=delete

virtual int	id () const
	Identifier for the output file 更多...

Private 成员函数
void	_writeCodeLink (const QCString &className, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip)

void	docify (const QCString &str)

Private 属性
bool	m_streamSet = false

TextStream &	m_t

QCString	m_relPath

QCString	m_sourceFileName

int	m_col = 0

bool	m_doxyCodeLineOpen = false

int	m_usedTableLevel = 0

详细描述

在文件 latexgen.h 第 28 行定义.

构造及析构函数说明

◆ LatexCodeGenerator() [1/2]

LatexCodeGenerator::LatexCodeGenerator	(	TextStream &	t,
		const QCString &	relPath,
		const QCString &	sourceFile
	)

在文件 latexgen.cpp 第 52 行定义.

   : m_t(t), m_relPath(relPath), m_sourceFileName(sourceFileName)
 {
 }

◆ LatexCodeGenerator() [2/2]

LatexCodeGenerator::LatexCodeGenerator ( TextStream & t )

在文件 latexgen.cpp 第 57 行定义.

                                                     : m_t(t)
 {
 }

成员函数说明

◆ _writeCodeLink()

void LatexCodeGenerator::_writeCodeLink	(	const QCString &	className,
		const QCString &	ref,
		const QCString &	file,
		const QCString &	anchor,
		const QCString &	name,
		const QCString &	tooltip
	)

private

◆ addWord()

void LatexCodeGenerator::addWord	(	const QCString &	,
		bool
	)

inlineoverridevirtual

实现了 CodeOutputInterface.

在文件 latexgen.h 第 54 行定义.

54 {}

◆ codify()

void LatexCodeGenerator::codify ( const QCString & s )

overridevirtual

Writes an code fragment to the output. This function should keep spaces visible, should break lines at a newline and should convert tabs to the right number of spaces.

实现了 CodeOutputInterface.

在文件 latexgen.cpp 第 71 行定义.

 {
   if (!str.isEmpty())
   {
     const signed char *p=(const signed char*)str.data();
     signed char c;
     //char cs[5];
     int spacesToNextTabStop;
     int tabSize = Config_getInt(TAB_SIZE);
     static THREAD_LOCAL signed char *result = NULL;
     static THREAD_LOCAL int lresult = 0;
     int i;
     while ((c=*p))
     {
       switch(c)
       {
         case 0x0c: p++;  // remove ^L
                    break;
         case ' ':  m_t <<" ";
                    m_col++;
                    p++;
                    break;
         case '^':  m_t <<"\\string^";
                    m_col++;
                    p++;
                    break;
         case '\t': spacesToNextTabStop =
                          tabSize - (m_col%tabSize);
                    for (i = 0; i < spacesToNextTabStop; i++) m_t <<" ";
                    m_col+=spacesToNextTabStop;
                    p++;
                    break;
         case '\n': m_t << '\n';
                    m_col=0;
                    p++;
                    break;
         default:
                    i=0;
  
 #undef  COPYCHAR
 // helper macro to copy a single utf8 character, dealing with multibyte chars.
 #define COPYCHAR() do {                                           \
                      int bytes = getUTF8CharNumBytes(c);          \
                      if (lresult < (i + bytes + 1))               \
                      {                                            \
                        lresult += 512;                            \
                        result = (signed char *)realloc(result, lresult); \
                      }                                            \
                      for (int j=0; j<bytes && *p; j++)            \
                      {                                            \
                        result[i++]=*p++;                          \
                      }                                            \
                      m_col++;                                     \
                    } while(0)
  
                    // gather characters until we find whitespace or another special character
                    COPYCHAR();
                    while ((c=*p) &&
                           c!=0x0c && c!='\t' && c!='\n' && c!=' ' && c!='^'
                          )
                    {
                      COPYCHAR();
                    }
                    result[i]=0; // add terminator
                    filterLatexString(m_t,(const char *)result,
                                      false, // insideTabbing
                                      true,  // insidePre
                                      false, // insideItem
                                      m_usedTableLevel>0, // insideTable
                                      false  // keepSpaces
                                     );
                    break;
       }
     }
   }
 }

引用了 Config_getInt, COPYCHAR, QCString::data(), filterLatexString(), QCString::isEmpty(), m_col, m_t, m_usedTableLevel , 以及 THREAD_LOCAL.

被这些函数引用 LatexGenerator::codify(), endCodeLine(), writeCodeLink() , 以及 writeLineNumber().

◆ decUsedTableLevel()

void LatexCodeGenerator::decUsedTableLevel ( )

inline

在文件 latexgen.h 第 60 行定义.

60 { m_usedTableLevel--; }

引用了 m_usedTableLevel.

被这些函数引用 LatexGenerator::endDescTable(), LatexGenerator::endMemberDocSimple() , 以及 LatexDocVisitor::visitPost().

◆ docify()

void LatexCodeGenerator::docify ( const QCString & str )

private

◆ endCodeFragment()

void LatexCodeGenerator::endCodeFragment ( const QCString & style )

overridevirtual

Ends a block of code

实现了 CodeOutputInterface.

在文件 latexgen.cpp 第 252 行定义.

 {
   //endCodeLine checks is there is still an open code line, if so closes it.
   endCodeLine();
  
   m_t << "\\end{" << style << "}\n";
 }

引用了 endCodeLine() , 以及 m_t.

被这些函数引用 LatexGenerator::endCodeFragment() , 以及 LatexDocVisitor::visit().

◆ endCodeLine()

void LatexCodeGenerator::endCodeLine ( )

overridevirtual

Ends a line of code started with startCodeLine()

实现了 CodeOutputInterface.

在文件 latexgen.cpp 第 227 行定义.

 {
   if (m_doxyCodeLineOpen)
   {
     m_t << "}";
     m_doxyCodeLineOpen = FALSE;
   }
   codify("\n");
 }

引用了 codify(), FALSE, m_doxyCodeLineOpen , 以及 m_t.

被这些函数引用 endCodeFragment() , 以及 LatexGenerator::endCodeLine().

◆ endFontClass()

void LatexCodeGenerator::endFontClass ( )

overridevirtual

Ends a block started with startFontClass()

实现了 CodeOutputInterface.

在文件 latexgen.cpp 第 242 行定义.

 {
   m_t << "}";
 }

引用了 m_t.

被这些函数引用 LatexGenerator::endFontClass().

◆ incUsedTableLevel()

void LatexCodeGenerator::incUsedTableLevel ( )

inline

在文件 latexgen.h 第 59 行定义.

59 { m_usedTableLevel++; }

引用了 m_usedTableLevel.

被这些函数引用 LatexGenerator::startDescTable(), LatexGenerator::startMemberDocSimple() , 以及 LatexDocVisitor::visitPre().

◆ setCurrentDoc()

void LatexCodeGenerator::setCurrentDoc	(	const Definition *	,
		const QCString &	,
		bool
	)

inlineoverridevirtual

实现了 CodeOutputInterface.

在文件 latexgen.h 第 53 行定义.

53 {}

◆ setRelativePath()

void LatexCodeGenerator::setRelativePath ( const QCString & path )

在文件 latexgen.cpp 第 61 行定义.

 {
   m_relPath = path;
 }

引用了 m_relPath.

被这些函数引用 LatexGenerator::startFile().

◆ setSourceFileName()

void LatexCodeGenerator::setSourceFileName ( const QCString & sourceFileName )

在文件 latexgen.cpp 第 66 行定义.

 {
   m_sourceFileName = name;
 }

引用了 m_sourceFileName.

被这些函数引用 LatexGenerator::endFile() , 以及 LatexGenerator::startFile().

◆ startCodeFragment()

void LatexCodeGenerator::startCodeFragment ( const QCString & style )

overridevirtual

Starts a source code fragment. The fragment will be fed to the code parser (see code.h) for syntax highlighting and cross-referencing. The fragment ends by a call to endCodeFragment()

参数

style The kind of code fragment.

实现了 CodeOutputInterface.

在文件 latexgen.cpp 第 247 行定义.

 {
   m_t << "\n\\begin{" << style << "}{" << m_usedTableLevel << "}\n";
 }

引用了 m_t , 以及 m_usedTableLevel.

被这些函数引用 LatexGenerator::startCodeFragment() , 以及 LatexDocVisitor::visit().

◆ startCodeLine()

void LatexCodeGenerator::startCodeLine ( bool )

overridevirtual

实现了 CodeOutputInterface.

在文件 latexgen.cpp 第 217 行定义.

 {
   m_col=0;
   if (!m_doxyCodeLineOpen)
   {
     m_t << "\\DoxyCodeLine{";
     m_doxyCodeLineOpen = TRUE;
   }
 }

引用了 m_col, m_doxyCodeLineOpen, m_t , 以及 TRUE.

被这些函数引用 LatexGenerator::startCodeLine().

◆ startFontClass()

void LatexCodeGenerator::startFontClass ( const QCString & clsName )

overridevirtual

Starts a block with a certain meaning. Used for syntax highlighting, which elements of the same type are rendered using the same 'font class'.

参数

clsName The category name.

实现了 CodeOutputInterface.

在文件 latexgen.cpp 第 237 行定义.

 {
   m_t << "\\textcolor{" << name << "}{";
 }

引用了 m_t.

被这些函数引用 LatexGenerator::startFontClass().

◆ usedTableLevel()

int LatexCodeGenerator::usedTableLevel ( ) const

inline

在文件 latexgen.h 第 61 行定义.

61 { return m_usedTableLevel; }

引用了 m_usedTableLevel.

被这些函数引用 LatexGenerator::docify() , 以及 LatexDocVisitor::filter().

◆ writeCodeAnchor()

void LatexCodeGenerator::writeCodeAnchor ( const QCString & name )

inlineoverridevirtual

Write an anchor to a source listing.

参数

name	The name of the anchor.

实现了 CodeOutputInterface.

在文件 latexgen.h 第 52 行定义.

52 {}

被这些函数引用 LatexGenerator::writeCodeAnchor().

◆ writeCodeLink()

void LatexCodeGenerator::writeCodeLink	(	CodeSymbolType	type,
		const QCString &	ref,
		const QCString &	file,
		const QCString &	anchor,
		const QCString &	name,
		const QCString &	tooltip
	)

overridevirtual

Writes a link to an object in a code fragment.

参数

type	The type of symbol, used for semantic syntax highlighting, may be Default is no info is available.
ref	If this is non-zero, the object is to be found in an external documentation file.
file	The file in which the object is located.
anchor	The anchor uniquely identifying the object within the file.
name	The text to display as a placeholder for the link.
tooltip	The tooltip to display when the mouse is on the link.

实现了 CodeOutputInterface.

在文件 latexgen.cpp 第 149 行定义.

 {
   bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
   bool usePDFLatex   = Config_getBool(USE_PDFLATEX);
   uint l = name.length();
   if (ref.isEmpty() && usePDFLatex && pdfHyperlinks)
   {
     m_t << "\\mbox{\\hyperlink{";
     if (!f.isEmpty()) m_t << stripPath(f);
     if (!f.isEmpty() && !anchor.isEmpty()) m_t << "_";
     if (!anchor.isEmpty()) m_t << anchor;
     m_t << "}{";
     codify(name);
     m_t << "}}";
   }
   else
   {
     codify(name);
   }
   m_col+=l;
 }

引用了 codify(), Config_getBool, QCString::isEmpty(), QCString::length(), m_col, m_t , 以及 stripPath().

被这些函数引用 LatexGenerator::writeCodeLink() , 以及 writeLineNumber().

◆ writeLineNumber()

void LatexCodeGenerator::writeLineNumber	(	const QCString &	ref,
		const QCString &	file,
		const QCString &	anchor,
		int	lineNumber,
		bool	writeLineAnchor
	)

overridevirtual

Writes the line number of a source listing

参数

ref	External reference (when imported from a tag file)
file	The file part of the URL pointing to the docs.
anchor	The anchor part of the URL pointing to the docs.
lineNumber	The line number to write
writeLineAnchor	Indicates if an anchor for the line number needs to be written

实现了 CodeOutputInterface.

在文件 latexgen.cpp 第 174 行定义.

 {
   bool usePDFLatex = Config_getBool(USE_PDFLATEX);
   bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
   if (!m_doxyCodeLineOpen)
   {
     m_t << "\\DoxyCodeLine{";
     m_doxyCodeLineOpen = TRUE;
   }
   if (Config_getBool(SOURCE_BROWSER))
   {
     QCString lineNumber;
     lineNumber.sprintf("%05d",l);
  
     QCString lineAnchor;
     if (!m_sourceFileName.isEmpty())
     {
       lineAnchor.sprintf("_l%05d",l);
       lineAnchor.prepend(stripExtensionGeneral(m_sourceFileName, ".tex"));
     }
     bool showTarget = usePDFLatex && pdfHyperlinks && !lineAnchor.isEmpty() && writeLineAnchor;
     if (showTarget)
     {
       m_t << "\\Hypertarget{" << stripPath(lineAnchor) << "}";
     }
     if (!fileName.isEmpty())
     {
       writeCodeLink(CodeSymbolType::Default,ref,fileName,anchor,lineNumber,QCString());
     }
     else
     {
       codify(lineNumber);
     }
     m_t << " ";
   }
   else
   {
     m_t << l << " ";
   }
   m_col=0;
 }

引用了 codify(), Config_getBool, Default, QCString::isEmpty(), m_col, m_doxyCodeLineOpen, m_sourceFileName, m_t, QCString::prepend(), QCString::sprintf(), stripExtensionGeneral(), stripPath(), TRUE , 以及 writeCodeLink().

被这些函数引用 LatexGenerator::writeLineNumber().

◆ writeTooltip()

void LatexCodeGenerator::writeTooltip	(	const QCString &	id,
		const DocLinkInfo &	docInfo,
		const QCString &	decl,
		const QCString &	desc,
		const SourceLinkInfo &	defInfo,
		const SourceLinkInfo &	declInfo
	)

inlineoverridevirtual

Writes a tool tip definition

参数

id	unique identifier for the tooltip
docInfo	Info about the symbol's documentation.
decl	full declaration of the symbol (for functions)
desc	brief description for the symbol
defInfo	Info about the symbol's definition in the source code
declInfo	Info about the symbol's declaration in the source code

实现了 CodeOutputInterface.

在文件 latexgen.h 第 40 行定义.

46 {}

被这些函数引用 LatexGenerator::writeTooltip().

类成员变量说明

◆ m_col

int LatexCodeGenerator::m_col = 0

private

在文件 latexgen.h 第 73 行定义.

被这些函数引用 codify(), startCodeLine(), writeCodeLink() , 以及 writeLineNumber().

◆ m_doxyCodeLineOpen

bool LatexCodeGenerator::m_doxyCodeLineOpen = false

private

在文件 latexgen.h 第 74 行定义.

被这些函数引用 endCodeLine(), startCodeLine() , 以及 writeLineNumber().

◆ m_relPath

QCString LatexCodeGenerator::m_relPath

private

在文件 latexgen.h 第 71 行定义.

被这些函数引用 setRelativePath().

◆ m_sourceFileName

QCString LatexCodeGenerator::m_sourceFileName

private

在文件 latexgen.h 第 72 行定义.

被这些函数引用 setSourceFileName() , 以及 writeLineNumber().

◆ m_streamSet

bool LatexCodeGenerator::m_streamSet = false

private

在文件 latexgen.h 第 69 行定义.

◆ m_t

TextStream& LatexCodeGenerator::m_t

private

在文件 latexgen.h 第 70 行定义.

被这些函数引用 codify(), endCodeFragment(), endCodeLine(), endFontClass(), startCodeFragment(), startCodeLine(), startFontClass(), writeCodeLink() , 以及 writeLineNumber().

◆ m_usedTableLevel

int LatexCodeGenerator::m_usedTableLevel = 0

private

在文件 latexgen.h 第 75 行定义.

被这些函数引用 codify(), decUsedTableLevel(), incUsedTableLevel(), startCodeFragment() , 以及 usedTableLevel().

该类的文档由以下文件生成:

src/latexgen.h
src/latexgen.cpp

Public 成员函数

Private 成员函数

Private 属性

详细描述

构造及析构函数说明

◆ LatexCodeGenerator() [1/2]

◆ LatexCodeGenerator() [2/2]

成员函数说明

◆ _writeCodeLink()

◆ addWord()

◆ codify()

◆ decUsedTableLevel()

◆ docify()

◆ endCodeFragment()

◆ endCodeLine()

◆ endFontClass()

◆ incUsedTableLevel()

◆ setCurrentDoc()

◆ setRelativePath()

◆ setSourceFileName()

◆ startCodeFragment()

◆ startCodeLine()

◆ startFontClass()

◆ usedTableLevel()

◆ writeCodeAnchor()

◆ writeCodeLink()

◆ writeLineNumber()

◆ writeTooltip()

类成员变量说明

◆ m_col

◆ m_doxyCodeLineOpen

◆ m_relPath

◆ m_sourceFileName

◆ m_streamSet

◆ m_t

◆ m_usedTableLevel