82 const char *p=str.
data();
107 case '^': *
m_t <<
"\\string^";
111 case '`': *
m_t <<
"\\`{}";
116 int spacesToNextTabStop = tabSize - (
m_col%tabSize);
117 while (spacesToNextTabStop--)
128 case '\n': *
m_t <<
'\n';
138#define COPYCHAR() do { \
139 int bytes = getUTF8CharNumBytes(c); \
140 if (lresult < (i + bytes + 1)) \
143 result = static_cast<char *>(realloc(result, lresult)); \
145 for (int j=0; j<bytes && *p; j++) \
155 c!=0x0c && c!=
'\t' && c!=
'\n' && c!=
' ' && c!=
'^'
205 if (ref.
isEmpty() && usePDFLatex && pdfHyperlinks)
207 *
m_t <<
"\\mbox{\\hyperlink{";
229 *
m_t <<
"\\DoxyCodeLine{";
240 lineAnchor.
sprintf(
"_l%05d",l);
243 bool showTarget = usePDFLatex && pdfHyperlinks && !lineAnchor.
isEmpty() && writeLineAnchor;
246 *
m_t <<
"\\Hypertarget{" <<
stripPath(lineAnchor) <<
"}";
275 *
m_t <<
"\\DoxyCodeLine{";
294 *
m_t <<
"\\textcolor{" << name <<
"}{";
316 *
m_t <<
"\\end{" << style <<
"}\n";
374 term(
"Could not open file {} for writing\n",fileName);
382 const int latex_count = 8;
384 t <<
"LATEX_CMD?=" << latex_command <<
"\n"
385 <<
"MKIDX_CMD?=" << mkidx_command <<
"\n"
386 <<
"BIBTEX_CMD?=" << bibtex_command <<
"\n"
387 <<
"LATEX_COUNT?=" << latex_count <<
"\n"
388 <<
"MANUAL_FILE?=" << manual_file <<
"\n"
392 t <<
"all: $(MANUAL_FILE).dvi\n"
394 <<
"ps: $(MANUAL_FILE).ps\n"
396 <<
"pdf: $(MANUAL_FILE).pdf\n"
398 <<
"ps_2on1: $(MANUAL_FILE).ps\n"
400 <<
"pdf_2on1: $(MANUAL_FILE).pdf\n"
402 <<
"$(MANUAL_FILE).ps: $(MANUAL_FILE).dvi\n"
403 <<
"\tdvips -o $(MANUAL_FILE).ps $(MANUAL_FILE).dvi\n"
405 t <<
"$(MANUAL_FILE).pdf: $(MANUAL_FILE).ps\n";
406 t <<
"\tps2pdf $(MANUAL_FILE).ps $(MANUAL_FILE).pdf\n\n";
407 t <<
"$(MANUAL_FILE).dvi: clean $(MANUAL_FILE).tex doxygen.sty\n"
408 <<
"\techo \"Running latex...\"\n"
409 <<
"\t$(LATEX_CMD) $(MANUAL_FILE).tex || \\\n"
410 <<
"\tif [ $$? != 0 ] ; then \\\n"
411 <<
"\t \\echo \"Please consult $(MANUAL_FILE).log to see the error messages\" ; \\\n"
414 <<
"\techo \"Running makeindex...\"\n"
415 <<
"\t$(MKIDX_CMD) $(MANUAL_FILE).idx\n";
418 t <<
"\techo \"Running bibtex...\"\n";
419 t <<
"\t$(BIBTEX_CMD) $(MANUAL_FILE)\n";
420 t <<
"\techo \"Rerunning latex....\"\n";
421 t <<
"\t$(LATEX_CMD) $(MANUAL_FILE).tex || \\\n"
422 <<
"\tif [ $$? != 0 ] ; then \\\n"
423 <<
"\t \\echo \"Please consult $(MANUAL_FILE).log to see the error messages\" ; \\\n"
427 t <<
"\techo \"Rerunning latex....\"\n"
428 <<
"\t$(LATEX_CMD) $(MANUAL_FILE).tex\n"
429 <<
"\tlatex_count=$(LATEX_COUNT) ; \\\n"
430 <<
"\twhile grep -E -s 'Rerun (LaTeX|to get cross-references right|to get bibliographical references right)' $(MANUAL_FILE).log && [ $$latex_count -gt 0 ] ;\\\n"
432 <<
"\t echo \"Rerunning latex....\" ;\\\n"
433 <<
"\t $(LATEX_CMD) $(MANUAL_FILE).tex ; \\\n"
434 <<
"\t $(LATEX_CMD) $(MANUAL_FILE).tex || \\\n"
435 <<
"\t if [ $$? != 0 ] ; then \\\n"
436 <<
"\t \\echo \"Please consult $(MANUAL_FILE).log to see the error messages\" ; \\\n"
439 <<
"\t latex_count=`expr $$latex_count - 1` ;\\\n"
441 <<
"\t$(MKIDX_CMD) $(MANUAL_FILE).idx\n"
442 <<
"\t$(LATEX_CMD) $(MANUAL_FILE).tex || \\\n"
443 <<
"\tif [ $$? != 0 ] ; then \\\n"
444 <<
"\t \\echo \"Please consult $(MANUAL_FILE).log to see the error messages\" ; \\\n"
447 <<
"$(MANUAL_FILE).ps: $(MANUAL_FILE).ps\n"
448 <<
"\tpsnup -2 $(MANUAL_FILE).ps >$(MANUAL_FILE).ps\n"
450 <<
"$(MANUAL_FILE).pdf: $(MANUAL_FILE).ps\n"
451 <<
"\tps2pdf $(MANUAL_FILE).ps $(MANUAL_FILE).pdf\n";
455 t <<
"all: $(MANUAL_FILE).pdf\n\n"
456 <<
"pdf: $(MANUAL_FILE).pdf\n\n";
457 t <<
"$(MANUAL_FILE).pdf: clean $(MANUAL_FILE).tex\n";
458 t <<
"\t$(LATEX_CMD) $(MANUAL_FILE) || \\\n"
459 <<
"\tif [ $$? != 0 ] ; then \\\n"
460 <<
"\t \\echo \"Please consult $(MANUAL_FILE).log to see the error messages\" ; \\\n"
463 t <<
"\t$(MKIDX_CMD) $(MANUAL_FILE).idx\n";
466 t <<
"\t$(BIBTEX_CMD) $(MANUAL_FILE)\n";
467 t <<
"\t$(LATEX_CMD) $(MANUAL_FILE) || \\\n"
468 <<
"\tif [ $$? != 0 ] ; then \\\n"
469 <<
"\t \\echo \"Please consult $(MANUAL_FILE).log to see the error messages\" ; \\\n"
473 t <<
"\t$(LATEX_CMD) $(MANUAL_FILE) || \\\n"
474 <<
"\tif [ $$? != 0 ] ; then \\\n"
475 <<
"\t \\echo \"Please consult $(MANUAL_FILE).log to see the error messages\" ; \\\n"
478 <<
"\tlatex_count=$(LATEX_COUNT) ; \\\n"
479 <<
"\twhile grep -E -s 'Rerun (LaTeX|to get cross-references right|to get bibliographical references right)' $(MANUAL_FILE).log && [ $$latex_count -gt 0 ] ;\\\n"
481 <<
"\t echo \"Rerunning latex....\" ;\\\n"
482 <<
"\t $(LATEX_CMD) $(MANUAL_FILE) || \\\n"
483 <<
"\t if [ $$? != 0 ] ; then \\\n"
484 <<
"\t \\echo \"Please consult $(MANUAL_FILE).log to see the error messages\" ; \\\n"
487 <<
"\t latex_count=`expr $$latex_count - 1` ;\\\n"
489 <<
"\t$(MKIDX_CMD) $(MANUAL_FILE).idx\n"
490 <<
"\t$(LATEX_CMD) $(MANUAL_FILE) || \\\n"
491 <<
"\tif [ $$? != 0 ] ; then \\\n"
492 <<
"\t \\echo \"Please consult $(MANUAL_FILE).log to see the error messages\" ; \\\n"
500 <<
"*.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.out *.brf *.blg *.bbl $(MANUAL_FILE).pdf\n";
512 const int latex_count = 8;
517 term(
"Could not open file {} for writing\n",fileName);
519 t <<
"pushd %~dp0\r\n";
520 t <<
"if not %errorlevel% == 0 goto :end1\r\n";
522 t <<
"set ORG_LATEX_CMD=%LATEX_CMD%\r\n";
523 t <<
"set ORG_MKIDX_CMD=%MKIDX_CMD%\r\n";
524 t <<
"set ORG_BIBTEX_CMD=%BIBTEX_CMD%\r\n";
525 t <<
"set ORG_LATEX_COUNT=%LATEX_COUNT%\r\n";
526 t <<
"set ORG_MANUAL_FILE=%MANUAL_FILE%\r\n";
527 t <<
"if \"X\"%LATEX_CMD% == \"X\" set LATEX_CMD=" << latex_command <<
"\r\n";
528 t <<
"if \"X\"%MKIDX_CMD% == \"X\" set MKIDX_CMD=" << mkidx_command <<
"\r\n";
529 t <<
"if \"X\"%BIBTEX_CMD% == \"X\" set BIBTEX_CMD=" << bibtex_command <<
"\r\n";
530 t <<
"if \"X\"%LATEX_COUNT% == \"X\" set LATEX_COUNT=" << latex_count <<
"\r\n";
531 t <<
"if \"X\"%MANUAL_FILE% == \"X\" set MANUAL_FILE=" << manual_file <<
"\r\n";
533 t <<
"del /s /f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.out *.brf *.blg *.bbl %MANUAL_FILE%.pdf\r\n\r\n";
537 t <<
"%LATEX_CMD% %MANUAL_FILE%.tex\r\n";
538 t <<
"@if ERRORLEVEL 1 goto :error\r\n";
539 t <<
"echo ----\r\n";
540 t <<
"%MKIDX_CMD% %MANUAL_FILE%.idx\r\n";
543 t <<
"%BIBTEX_CMD% %MANUAL_FILE%\r\n";
544 t <<
"echo ----\r\n";
545 t <<
"\t%LATEX_CMD% %MANUAL_FILE%.tex\r\n";
546 t <<
"@if ERRORLEVEL 1 goto :error\r\n";
548 t <<
"setlocal enabledelayedexpansion\r\n";
549 t <<
"set count=%LAT#EX_COUNT%\r\n";
551 t <<
"set content=X\r\n";
552 t <<
"for /F \"tokens=*\" %%T in ( 'findstr /C:\"Rerun LaTeX\" %MANUAL_FILE%.log' ) do set content=\"%%~T\"\r\n";
553 t <<
"if !content! == X for /F \"tokens=*\" %%T in ( 'findstr /C:\"Rerun to get cross-references right\" %MANUAL_FILE%.log' ) do set content=\"%%~T\"\r\n";
554 t <<
"if !content! == X for /F \"tokens=*\" %%T in ( 'findstr /C:\"Rerun to get bibliographical references right\" %MANUAL_FILE%.log' ) do set content=\"%%~T\"\r\n";
555 t <<
"if !content! == X goto :skip\r\n";
556 t <<
"set /a count-=1\r\n";
557 t <<
"if !count! EQU 0 goto :skip\r\n\r\n";
558 t <<
"echo ----\r\n";
559 t <<
"%LATEX_CMD% %MANUAL_FILE%.tex\r\n";
560 t <<
"@if ERRORLEVEL 1 goto :error\r\n";
561 t <<
"goto :repeat\r\n";
564 t <<
"%MKIDX_CMD% %MANUAL_FILE%.idx\r\n";
565 t <<
"%LATEX_CMD% %MANUAL_FILE%.tex\r\n";
566 t <<
"@if ERRORLEVEL 1 goto :error\r\n";
567 t <<
"dvips -o %MANUAL_FILE%.ps %MANUAL_FILE%.dvi\r\n";
569 t <<
" -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite "
570 "-sOutputFile=%MANUAL_FILE%.pdf -c save pop -f %MANUAL_FILE%.ps\r\n";
574 t <<
"%LATEX_CMD% %MANUAL_FILE%\r\n";
575 t <<
"@if ERRORLEVEL 1 goto :error\r\n";
576 t <<
"echo ----\r\n";
577 t <<
"%MKIDX_CMD% %MANUAL_FILE%.idx\r\n";
580 t <<
"%BIBTEX_CMD% %MANUAL_FILE%\r\n";
581 t <<
"%LATEX_CMD% %MANUAL_FILE%\r\n";
582 t <<
"@if ERRORLEVEL 1 goto :error\r\n";
584 t <<
"echo ----\r\n";
585 t <<
"%LATEX_CMD% %MANUAL_FILE%\r\n";
586 t <<
"@if ERRORLEVEL 1 goto :error\r\n";
588 t <<
"setlocal enabledelayedexpansion\r\n";
589 t <<
"set count=%LATEX_COUNT%\r\n";
591 t <<
"set content=X\r\n";
592 t <<
"for /F \"tokens=*\" %%T in ( 'findstr /C:\"Rerun LaTeX\" %MANUAL_FILE%.log' ) do set content=\"%%~T\"\r\n";
593 t <<
"if !content! == X for /F \"tokens=*\" %%T in ( 'findstr /C:\"Rerun to get cross-references right\" %MANUAL_FILE%.log' ) do set content=\"%%~T\"\r\n";
594 t <<
"if !content! == X for /F \"tokens=*\" %%T in ( 'findstr /C:\"Rerun to get bibliographical references right\" %MANUAL_FILE%.log' ) do set content=\"%%~T\"\r\n";
595 t <<
"if !content! == X goto :skip\r\n";
596 t <<
"set /a count-=1\r\n";
597 t <<
"if !count! EQU 0 goto :skip\r\n\r\n";
598 t <<
"echo ----\r\n";
599 t <<
"%LATEX_CMD% %MANUAL_FILE%\r\n";
600 t <<
"@if ERRORLEVEL 1 goto :error\r\n";
601 t <<
"goto :repeat\r\n";
604 t <<
"%MKIDX_CMD% %MANUAL_FILE%.idx\r\n";
605 t <<
"%LATEX_CMD% %MANUAL_FILE%\r\n";
606 t <<
"@if ERRORLEVEL 1 goto :error\r\n";
609 t <<
"goto :end\r\n";
611 t <<
"@echo ===============\r\n";
612 t <<
"@echo Please consult %MANUAL_FILE%.log to see the error messages\r\n";
613 t <<
"@echo ===============\r\n";
616 t<<
"@REM reset environment\r\n";
618 t<<
"set LATEX_CMD=%ORG_LATEX_CMD%\r\n";
619 t<<
"set ORG_LATEX_CMD=\r\n";
620 t<<
"set MKIDX_CMD=%ORG_MKIDX_CMD%\r\n";
621 t<<
"set ORG_MKIDX_CMD=\r\n";
622 t<<
"set BIBTEX_CMD=%ORG_BIBTEX_CMD%\r\n";
623 t<<
"set ORG_BIBTEX_CMD=\r\n";
624 t<<
"set MANUAL_FILE=%ORG_MANUAL_FILE%\r\n";
625 t<<
"set ORG_MANUAL_FILE=\r\n";
626 t<<
"set LATEX_COUNT=%ORG_LATEX_COUNT%\r\n";
627 t<<
"set ORG_LATEX_COUNT=\r\n";
639 term(
"Could not create output directory {}\n",dname);
693 t <<
"% Latex header for doxygen " << getDoxygenVersion() <<
"\n";
699 t <<
"% Latex footer for doxygen " << getDoxygenVersion() <<
"\n";
705 t <<
"% stylesheet for doxygen " << getDoxygenVersion() <<
"\n";
736 m_t <<
"\\\\[1ex]\\large ";
743 for (
const auto &fileName : extraLatexStyles)
745 if (!fileName.empty())
750 result +=
"\\usepackage{";
772 if (!latex_mkidx_command.
isEmpty())
774 if (latex_mkidx_command[0] ==
'\\')
775 result += latex_mkidx_command;
777 result +=
"\\"+latex_mkidx_command;
781 result +=
"\\makeindex";
790 case LATEX_BATCHMODE_t::NO:
return "";
791 case LATEX_BATCHMODE_t::YES:
return "\\batchmode";
792 case LATEX_BATCHMODE_t::BATCH:
return "\\batchmode";
793 case LATEX_BATCHMODE_t::NON_STOP:
return "\\nonstopmode";
794 case LATEX_BATCHMODE_t::SCROLL:
return "\\scrollmode";
795 case LATEX_BATCHMODE_t::ERROR_STOP:
return "\\errorstopmode";
820 case TIMESTAMP_t::YES:
821 case TIMESTAMP_t::DATETIME:
825 case TIMESTAMP_t::DATE:
829 case TIMESTAMP_t::NO:
840 generatedBy = tg.
str();
845 if (latexEmojiDirectory.
isEmpty()) latexEmojiDirectory =
".";
846 latexEmojiDirectory =
substitute(latexEmojiDirectory,
"\\",
"/");
858 if (!formulaMacrofile.
isEmpty())
882 {
"$latexdocumentpre", [&]() {
return theTranslator->latexDocumentPre(); } },
883 {
"$latexdocumentpost", [&]() {
return theTranslator->latexDocumentPost(); } },
884 {
"$generatedby", [&]() {
return generatedBy; } },
885 {
"$latexbibstyle", [&]() {
return style; } },
886 {
"$latexcitereference", [&]() {
return theTranslator->trCiteReferences(); } },
888 {
"$papertype", [&]() {
return paperType+
"paper"; } },
890 {
"$languagesupport", [&]() {
return theTranslator->latexLanguageSupportCommand(); } },
891 {
"$latexfontenc", [&]() {
return latexFontenc; } },
892 {
"$latexfont", [&]() {
return theTranslator->latexFont(); } },
893 {
"$latexemojidirectory", [&]() {
return latexEmojiDirectory; } },
894 {
"$makeindex", [&]() {
return makeIndex(); } },
895 {
"$extralatexpackages", [&]() {
return extraLatexPackages; } },
896 {
"$latexspecialformulachars", [&]() {
return latexSpecialFormulaChars; } },
897 {
"$formulamacrofile", [&]() {
return stripMacroFile; } },
906 {
"COMPACT_LATEX", compactLatex },
907 {
"PDF_HYPERLINKS", pdfHyperlinks },
908 {
"USE_PDFLATEX", usePdfLatex },
909 {
"TIMESTAMP", timeStamp!=TIMESTAMP_t::NO },
910 {
"LATEX_FONTENC", !latexFontenc.
isEmpty() },
911 {
"FORMULA_MACROFILE", !formulaMacrofile.
isEmpty() },
912 {
"PROJECT_NUMBER", !projectNumber.
isEmpty() }
933 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
937 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
941 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
945 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
949 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
953 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
957 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
961 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
965 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
972 if (!gd->isReference())
974 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
985 if (!mod->isReference() && mod->isPrimaryInterface())
987 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
998 if (dd->isLinkableInProject())
1000 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
1011 if (nd->isLinkableInProject() && !nd->isAlias())
1013 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
1024 if (cd->isLinkableInProject() && !cd->isAlias())
1026 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
1037 if (cd->isLinkableInProject() &&
1038 !cd->isImplicitTemplateInstance() &&
1039 !cd->isEmbeddedInOuterScope() &&
1043 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
1055 for (
const auto &fd : *fn)
1057 if (fd->isLinkableInProject() || fd->generateSourceFile())
1061 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
1073 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
1103 m_t <<
"}\n\\input{modules}\n";
1106 m_t <<
"}\n\\input{topics}\n";
1109 m_t <<
"}\n\\input{dirs}\n";
1112 m_t <<
"}\n\\input{namespaces}\n";
1115 m_t <<
"}\n\\input{concepts}\n";
1118 m_t <<
"}\n\\input{hierarchy}\n";
1121 m_t <<
"}\n\\input{annotated}\n";
1124 m_t <<
"}\n\\input{files}\n";
1127 m_t <<
"}\n\\input{pages}\n";
1134 if (!gd->isReference() && !gd->isASubGroup())
1146 if (!mod->isReference() && mod->isPrimaryInterface())
1158 if (dd->isLinkableInProject())
1165 m_t <<
"\\input{" << dd->getOutputFileBase() <<
"}\n";
1175 if (nd->isLinkableInProject() && !nd->isAlias())
1182 m_t <<
"\\input{" << nd->getOutputFileBase() <<
"}\n";
1192 if (cd->isLinkableInProject() && !cd->isAlias())
1199 m_t <<
"\\input{" << cd->getOutputFileBase() <<
"}\n";
1209 if (cd->isLinkableInProject() &&
1210 !cd->isImplicitTemplateInstance() &&
1211 !cd->isEmbeddedInOuterScope() &&
1220 m_t <<
"\\input{" << cd->getOutputFileBase() <<
"}\n";
1230 for (
const auto &fd : *fn)
1232 if (fd->isLinkableInProject())
1239 m_t <<
"\\input{" << fd->getOutputFileBase() <<
"}\n";
1241 if (fd->generateSourceFile())
1248 m_t <<
"\\input{" << fd->getSourceFileBase() <<
"}\n";
1259 m_t <<
"\\input{" << pd->getOutputFileBase() <<
"}\n";
1267 if (!pd->getGroupDef() && !pd->isReference() && !pd->hasParentPage()
1289 m_t <<
"{" << name <<
"}\n";
1311 m_t <<
"\n" <<
"\n";
1316 m_t <<
"\n" <<
"\n";
1329 m_t <<
"\\contentsline{section}{";
1344 m_t <<
"\\item\\contentsline{section}\\textbf{ ";
1352 m_t <<
"\\item\\contentsline{section}{";
1362 if (hasBrief)
m_t <<
"\\\\*";
1384 m_t <<
"\\mbox{\\hyperlink{";
1391 m_t <<
"\\textbf{ ";
1407 bool insideTabbing,
bool disableLinks)
1411 if (!disableLinks && ref.
isEmpty() && pdfHyperlinks)
1413 result +=
"\\mbox{\\hyperlink{";
1416 if (!anchor.
isEmpty()) result += anchor;
1423 result +=
"\\textbf{ ";
1434 t <<
"\\texorpdfstring{";
1439 t <<
"}{" << strRepl <<
"}";
1451 m_t <<
" \\doxyref{}{";
1471 if (hierarchyLevel < 0)
1472 m_t <<
"\\chapter{";
1483 if (usePDFLatex && pdfHyperlinks && !
fileName.isEmpty())
1491 m_t <<
"\\label{" << fn <<
"}";
1507 m_t <<
"\\doxysubsection{";
1511 m_t <<
"\\doxysection{";
1522 if (extraIndentLevel>=3)
1524 m_t <<
"\\doxysubparagraph*{";
1526 else if (extraIndentLevel==2)
1528 m_t <<
"\\doxyparagraph{";
1570 if (!memname.
isEmpty() && memname[0]!=
'@')
1604 m_t <<
"\\doxysubparagraph";
1606 else if (compactLatex)
1608 m_t <<
"\\doxyparagraph";
1618 m_t <<
"\\texorpdfstring{";
1627 m_t <<
"\\hspace{0.1cm}{\\footnotesize\\ttfamily [" << memCount <<
"/" << memTotal <<
"]}";
1630 m_t <<
"\n{\\footnotesize\\ttfamily ";
1648 if (usePDFLatex && pdfHyperlinks)
1650 m_t <<
"\\Hypertarget{";
1676 if (usePDFLatex && pdfHyperlinks)
1721 if (usePDFLatex && pdfHyperlinks)
1728 switch(
type.level())
1737 default:
ASSERT(0);
break;
1743 switch(
type.level())
1752 default:
ASSERT(0);
break;
1760 m_t <<
"}\\label{" << lab <<
"}\n";
1800 m_t <<
"\\begin{tabbing}\n";
1801 m_t <<
"xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=\\kill\n";
1811 m_t <<
"\n" <<
"\\end{tabbing}";
1821 m_t <<
"{\\footnotesize ";
1857 m_t <<
"\\begin{DoxyCompactList}\\small\\item\\em ";
1871 m_t <<
"\\end{DoxyCompactList}";
1910 m_t <<
"\\begin{DoxyEnumFields}[" << (hasInits?3:2) <<
"]{" << title <<
"}\n";
1916 m_t <<
"\\end{DoxyEnumFields}\n";
1923 m_t <<
"\\raisebox{\\heightof{T}}[0pt][0pt]{";
1955 m_t <<
"\\\\\n\\hline\n\n";
1967 m_t <<
"\\begin{DoxyCompactItemize}\n";
1976 m_t <<
"\\end{DoxyCompactItemize}\n";
1983 if (hasHeader)
m_t <<
"\\begin{Indent}";
1984 m_t <<
"\\textbf{ ";
2019 if (hasHeader)
m_t <<
"\\end{Indent}";
2025 m_t <<
"\n" <<
"\n";
2071 m_t <<
"\\begin{Desc}\n\\item[";
2078 m_t <<
"\\end{Desc}\n";
2084 if (openBracket)
m_t <<
"(";
2085 m_t <<
"\\begin{DoxyParamCaption}";
2123 m_t <<
"\\end{DoxyParamCaption}";
2124 if (closeBracket)
m_t <<
")";
2134 else if (closeBracket)
2149 std::visit(visitor,astImpl->
root);
2155 m_t <<
"\\begin{Desc}\n\\item[";
2158 m_t <<
"\\begin{description}\n";
2163 m_t <<
"\\item[{\\em ";
2172 m_t <<
"} : {\\em ";
2190 m_t <<
"\\end{description}\n";
2191 m_t <<
"\\end{Desc}\n";
2198 m_t <<
"\\doxyparagraph*{";
2219 m_t <<
"\\newline\n";
2228 m_t <<
"\\begin{DoxyEnumFields}{";
2233 m_t <<
"\\begin{DoxyFields}{";
2246 m_t <<
"\\end{DoxyEnumFields}\n";
2250 m_t <<
"\\end{DoxyFields}\n";
2282 m_t <<
"\\\\\n\\hline\n\n";
2287 m_t <<
"\\hspace{0.3cm}";
2292 m_t <<
"{\\ttfamily [" << l <<
"]}";
2293 if (!isLast)
m_t <<
", ";
2307 m_t <<
"\\doxyparagraph*{";
2321 m_t <<
"\\etocsetnexttocdepth{" << maxLevel <<
"}\n";
2322 m_t <<
"\\localtableofcontents\n";
2331 if (!extraPackages.empty())
2333 t <<
"% Packages requested by user\n";
2334 for (
const auto &pkgName : extraPackages)
2336 if ((pkgName[0] ==
'[') || (pkgName[0] ==
'{'))
2337 t <<
"\\usepackage" << pkgName <<
"\n";
2339 t <<
"\\usepackage{" << pkgName <<
"}\n";
2347 unsigned char minus[4];
2348 unsigned char sup2[3];
2349 unsigned char sup3[3];
2361 t <<
"\\ifPDFTeX\n";
2362 t <<
"\\usepackage{newunicodechar}\n";
2365 t <<
" \\makeatletter\n"
2366 " \\def\\doxynewunicodechar#1#2{%\n"
2367 " \\@tempswafalse\n"
2368 " \\edef\\nuc@tempa{\\detokenize{#1}}%\n"
2369 " \\if\\relax\\nuc@tempa\\relax\n"
2370 " \\nuc@emptyargerr\n"
2372 " \\edef\\@tempb{\\expandafter\\@car\\nuc@tempa\\@nil}%\n"
2375 " \\@namedef{u8:\\nuc@tempa}{#2}%\n"
2381 t <<
" \\doxynewunicodechar{" << minus <<
"}{${}^{-}$}% Superscript minus\n"
2382 " \\doxynewunicodechar{" << sup2 <<
"}{${}^{2}$}% Superscript two\n"
2383 " \\doxynewunicodechar{" << sup3 <<
"}{${}^{3}$}% Superscript three\n"
2389 bool insideTabbing,
bool insidePre,
bool insideItem,
bool insideTable,
bool keepSpaces,
const bool retainNewline)
2394 const char *p = str.
data();
2395 const char *q =
nullptr;
2396 unsigned char pc=
'\0';
2400 unsigned char c=
static_cast<unsigned char>(*p++);
2408 if (
static_cast<unsigned char>(*(p)) == 0xbf &&
static_cast<unsigned char>(*(p+1)) == 0xbd)
2414 t << static_cast<char>(c);
2416 case '\\': t <<
"\\(\\backslash\\)";
break;
2417 case '{': t <<
"\\{";
break;
2418 case '}': t <<
"\\}";
break;
2419 case '_': t <<
"\\_";
break;
2420 case '&': t <<
"\\&";
break;
2421 case '%': t <<
"\\%";
break;
2422 case '#': t <<
"\\#";
break;
2423 case '$': t <<
"\\$";
break;
2424 case '"': t <<
"\"{}";
break;
2425 case '-': t <<
"-\\/";
break;
2426 case '^':
insideTable ? t <<
"\\string^" : t << static_cast<char>(c);
break;
2427 case '~': t <<
"\\string~";
break;
2428 case '\n':
if (retainNewline) t <<
"\\newline";
else t <<
' ';
2430 case ' ':
if (keepSpaces) t <<
"~";
else t <<
' ';
2434 else t << static_cast<char>(c);
2444 if (
static_cast<unsigned char>(*(p)) == 0xbf &&
static_cast<unsigned char>(*(p+1)) == 0xbd)
2450 t << static_cast<char>(c);
2452 case '#': t <<
"\\#";
break;
2453 case '$': t <<
"\\$";
break;
2454 case '%': t <<
"\\%";
break;
2455 case '^':
processEntity(t,pdfHyperlinks,
"$^\\wedge$",
"\\string^");
break;
2460 while ((*q >=
'a' && *q <=
'z') || (*q >=
'A' && *q <=
'Z') || (*q >=
'0' && *q <=
'9'))
2487 case '*':
processEntity(t,pdfHyperlinks,
"$\\ast$",
"*");
break;
2488 case '_':
if (!insideTabbing) t <<
"\\+";
2490 if (!insideTabbing) t <<
"\\+";
2492 case '{': t <<
"\\{";
break;
2493 case '}': t <<
"\\}";
break;
2494 case '<': t <<
"$<$";
break;
2495 case '>': t <<
"$>$";
break;
2496 case '|':
processEntity(t,pdfHyperlinks,
"$\\vert$",
"|");
break;
2497 case '~':
processEntity(t,pdfHyperlinks,
"$\\sim$",
"\\string~");
break;
2503 case ']':
if (pc==
'[') t <<
"$\\,$";
2509 case '-': t <<
"-\\/";
2511 case '\\': t <<
"\\textbackslash{}";
2513 case '"': t <<
"\"{}";
2515 case '`': t <<
"\\`{}";
2517 case '\'': t <<
"\\textquotesingle{}";
2519 case '\n':
if (retainNewline)
2529 case ' ':
if (keepSpaces) {
if (insideTabbing) t <<
"\\>";
else t <<
'~'; }
else t <<
' ';
2534 if (!insideTabbing &&
2535 ((c>=
'A' && c<=
'Z' && pc!=
' ' && !(pc>=
'A' && pc <=
'Z') && pc!=
'\0' && *p) || (c==
':' && pc!=
':') || (pc==
'.' &&
isId(c)))
2546 t << static_cast<char>(c);
2567 const char *p=s.
data();
2573 case '|': t <<
"\\texttt{\"|}";
break;
2574 case '!': t <<
"\"!";
break;
2575 case '@': t <<
"\"@";
break;
2576 case '%': t <<
"\\%";
break;
2577 case '{': t <<
"\\lcurly{}";
break;
2578 case '}': t <<
"\\rcurly{}";
break;
2579 case '~': t <<
"````~";
break;
2586 while ((c=*p) && c!=
'@' && c!=
'[' && c!=
']' && c!=
'!' && c!=
'{' && c!=
'}' && c!=
'|')
2612 const char *p=s.
data();
2618 case '!': t <<
"\"!";
break;
2619 case '"': t <<
"\"\"";
break;
2620 case '@': t <<
"\"@";
break;
2621 case '|': t <<
"\\texttt{\"|}";
break;
2622 case '[': t <<
"[";
break;
2623 case ']': t <<
"]";
break;
2624 case '{': t <<
"\\lcurly{}";
break;
2625 case '}': t <<
"\\rcurly{}";
break;
2632 while ((c=*p) && c!=
'"' && c!=
'@' && c!=
'[' && c!=
']' && c!=
'!' && c!=
'{' && c!=
'}' && c!=
'|')
2656 const char *p=s.
data();
2662 case '\\': t <<
"\\textbackslash{}";
break;
2663 case '{': t <<
"\\{";
break;
2664 case '}': t <<
"\\}";
break;
2665 case '_': t <<
"\\_";
break;
2666 case '%': t <<
"\\%";
break;
2667 case '&': t <<
"\\&";
break;
2668 case '#': t <<
"\\#";
break;
2669 case '$': t <<
"\\$";
break;
2670 case '^': t <<
"\\string^";
break;
2671 case '~': t <<
"\\string~";
break;
2682 constexpr auto hex =
"0123456789ABCDEF";
2685 const char *p=s.
data();
2691 case '#': t <<
"\\#";
break;
2692 case '%': t <<
"\\%";
break;
2693 case '\\': t <<
"\\\\";
break;
2697 unsigned char id =
static_cast<unsigned char>(c);
2698 t <<
"\\%" <<
hex[
id>>4] <<
hex[
id&0xF];
QCString latexBibFiles()
lists the bibtex cite files in a comma separated list
static CitationManager & instance()
bool isEmpty() const
return TRUE if there are no citations.
Class representing a built-in class diagram.
void writeFigure(TextStream &t, const QCString &path, const QCString &file) const
The common base class of all entity definitions found in the sources.
virtual QCString getDefFileExtension() const =0
Class representing a directory in the file system.
bool mkdir(const std::string &path, bool acceptsAbsPath=true) const
Class representing the abstract syntax tree of a documentation block.
Representation of an call graph.
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)
Representation of a class inheritance or dependency graph.
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool TBRank=TRUE, bool imageMap=TRUE, int graphId=-1)
Representation of an directory dependency graph.
QCString writeGraph(TextStream &out, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1, bool linkRelations=TRUE)
Representation of a group collaboration graph.
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)
Representation of an include dependency graph.
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)
static NamespaceLinkedMap * namespaceLinkedMap
static ConceptLinkedMap * conceptLinkedMap
static std::unique_ptr< PageDef > mainPage
static FileNameLinkedMap * inputNameLinkedMap
static ClassLinkedMap * classLinkedMap
static PageLinkedMap * exampleLinkedMap
static PageLinkedMap * pageLinkedMap
static DirLinkedMap * dirLinkedMap
static GroupLinkedMap * groupLinkedMap
Minimal replacement for QFileInfo.
std::string fileName() const
std::string absFilePath() const
const char * latex(SymType symb) const
Access routine to the LaTeX code of the HTML entity.
static HtmlEntityMapper & instance()
Returns the one and only instance of the HTML entity mapper.
SymType name2sym(const QCString &symName) const
Give code of the requested HTML entity name.
opaque representation of the abstract syntax tree (AST)
Generator for LaTeX code fragments.
void setStripIndentAmount(size_t amount) override
void endFontClass() override
void writeLineNumber(const QCString &, const QCString &, const QCString &, int, bool) override
void setSourceFileName(const QCString &sourceFileName)
void setRelativePath(const QCString &path)
void startFontClass(const QCString &) override
void endSpecialComment() override
void stripCodeComments(bool b) override
void startCodeFragment(const QCString &style) override
size_t m_stripIndentAmount
void startCodeLine(int) override
LatexCodeGenerator(TextStream *t, const QCString &relPath, const QCString &sourceFile)
void startSpecialComment() override
void endCodeFragment(const QCString &style) override
QCString m_sourceFileName
void codify(const QCString &text) override
void endCodeLine() override
void writeCodeLink(CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip) override
Concrete visitor implementation for LaTeX output.
void endMemberItem(MemberItemType) override
void addCodeGen(OutputCodeList &list) override
void endIndexKey() override
void endInlineMemberDoc() override
void startProjectNumber() override
void endPageRef(const QCString &, const QCString &) override
void endSection(const QCString &, SectionType) override
void startIndexSection(IndexSection) override
void endParameterList() override
void endMemberDescription() override
std::unique_ptr< OutputCodeList > m_codeList
void endDirDepGraph(DotDirDeps &g) override
void endDescTable() override
void startParameterType(bool, const QCString &) override
void startMemberGroup() override
void endInlineHeader() override
void endGroupHeader(int) override
void startMemberDoc(const QCString &, const QCString &, const QCString &, const QCString &, int, int, bool) override
void writeChar(char c) override
void endDescTableInit() override
void startParameterName(bool) override
void endMemberTemplateParams(const QCString &, const QCString &) override
void endParameterType() override
void startPageRef() override
void writeInheritedSectionTitle(const QCString &, const QCString &, const QCString &, const QCString &, const QCString &, const QCString &) override
void endLabels() override
void startParagraph(const QCString &classDef) override
void endIndexSection(IndexSection) override
void startConstraintType() override
void startClassDiagram() override
void endInlineMemberType() override
void startDescTableTitle() override
void startSection(const QCString &, const QCString &, SectionType) override
void writeString(const QCString &text) override
void endInclDepGraph(DotInclDepGraph &) override
void writeNonBreakableSpace(int) override
void startMemberGroupDocs() override
void endDescTableTitle() override
void startInclDepGraph() override
void lastIndexPage() override
void endExamples() override
void startLocalToc(int level) override
void endMemberGroupHeader() override
void docify(const QCString &text) override
void startAnonTypeScope(int) override
void endPlainFile() override
void startDoxyAnchor(const QCString &, const QCString &, const QCString &, const QCString &, const QCString &) override
static void writeFooterFile(TextStream &t)
void startParameterList(bool) override
void endMemberDoc(bool) override
void endConstraintType() override
void startDescTableRow() override
void endAnonTypeScope(int) override
void startMemberHeader(const QCString &, int) override
void endConstraintList() override
void startDotGraph() override
void endParameterExtra(bool last, bool one, bool bracket) override
void endDescTableData() override
void writeLabel(const QCString &l, bool isLast) override
void startTextLink(const QCString &, const QCString &) override
void startConstraintList(const QCString &) override
void startGroupCollaboration() override
void startLabels() override
static void writeStyleSheetFile(TextStream &t)
void endTitleHead(const QCString &, const QCString &name) override
void endMemberHeader() override
OutputType type() const override
void endIndexItem(const QCString &ref, const QCString &file) override
void startGroupHeader(const QCString &, int) override
void startDescTable(const QCString &title, const bool hasInits) override
void endConstraintDocs() override
void startIndexKey() override
void writeDoc(const IDocNodeAST *node, const Definition *ctx, const MemberDef *, int id) override
void startConstraintParam() override
void lineBreak(const QCString &style=QCString()) override
void endInlineMemberName() override
void startMemberTemplateParams() override
void startInlineMemberType() override
void startInlineMemberDoc() override
void writeAnchor(const QCString &fileName, const QCString &name) override
void startCallGraph() override
void endMemberList() override
void startExamples() override
LatexGenerator & operator=(const LatexGenerator &)
void startDirDepGraph() override
void endTextLink() override
void writeStartAnnoItem(const QCString &type, const QCString &file, const QCString &path, const QCString &name) override
void startMemberList() override
void startDescTableData() override
void endDescTableRow() override
void startConstraintDocs() override
void endMemberGroupDocs() override
void endClassDiagram(const ClassDiagram &, const QCString &, const QCString &) override
void startDescTableInit() override
void endMemberDocSimple(bool) override
void addIndexItem(const QCString &, const QCString &) override
void endParameterName() override
void endIndexValue(const QCString &, bool) override
void writeObjectLink(const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name) override
void startMemberDocSimple(bool) override
void startPlainFile(const QCString &name) override
void exceptionEntry(const QCString &, bool) override
void endCallGraph(DotCallGraph &) override
void endGroupCollaboration(DotGroupCollaboration &g) override
void startIndexItem(const QCString &ref, const QCString &file) override
void startFile(const QCString &name, const QCString &manName, const QCString &title, int id, int hierarchyLevel) override
void startTitleHead(const QCString &) override
void startInlineHeader() override
void endConstraintParam() override
void endDotGraph(DotClassGraph &) override
void writePageLink(const QCString &, bool) override
void startParameterExtra() override
LatexCodeGenerator * m_codeGen
void endMemberGroup(bool) override
void startMemberGroupHeader(const QCString &, bool) override
void startMemberDescription(const QCString &, const QCString &, bool) override
void startMemberItem(const QCString &, MemberItemType, const QCString &) override
static void writeHeaderFile(TextStream &t)
void endParagraph() override
void addLabel(const QCString &, const QCString &) override
void writeStyleInfo(int part) override
void endDoxyAnchor(const QCString &, const QCString &) override
void startIndexValue(bool) override
void startInlineMemberName() override
bool m_templateMemberItem
A model of a class/file/namespace member symbol.
static ModuleManager & instance()
Class representing a list of different code generators.
void add(OutputCodeIntfPtr &&p)
Abstract interface for output generators.
QCString fileName() const
This is an alternative implementation of QCString.
QCString & prepend(const char *s)
size_t length() const
Returns the length of the string, not counting the 0-terminator.
bool isEmpty() const
Returns TRUE iff the string is empty.
QCString repeat(unsigned int n) const
const std::string & str() const
QCString & sprintf(const char *format,...)
const char * data() const
Returns a pointer to the contents of the string in the form of a 0-terminated C string.
static ResourceMgr & instance()
Returns the one and only instance of this class.
QCString getAsString(const QCString &name) const
Gets the resource data as a C string.
static constexpr int Section
static constexpr int Subsection
static constexpr int Subsubsection
static constexpr int Page
static constexpr int Paragraph
static constexpr int Subsubparagraph
static constexpr int Subparagraph
Text streaming class that buffers data.
std::string str() const
Return the contents of the buffer as a std::string object.
#define Config_getInt(name)
#define Config_getList(name)
#define Config_getEnumAsString(name)
#define Config_getBool(name)
#define Config_getString(name)
#define Config_getEnum(name)
std::vector< std::string > StringVector
QCString dateToString(DateTimeType includeTime)
Returns the current date, when includeTime is set also the time is provided.
QCString yearToString()
Returns the current year as a string.
static constexpr auto hex
static QCString objectLinkToString(const QCString &, const QCString &f, const QCString &anchor, const QCString &text)
bool insideTable(const DocNodeVariant *n)
static QCString g_header_file
static QCString g_footer_file
static void writeDefaultStyleSheet(TextStream &t)
@ isNamespaceDocumentation
Translator * theTranslator
static QCString latex_batchmode()
QCString latexEscapePDFString(const QCString &s)
QCString convertToLaTeX(const QCString &s, bool insideTabbing, bool keepSpaces)
static QCString makeIndex()
QCString latexFilterURL(const QCString &s)
static void writeLatexMakefile()
static const SelectionMarkerInfo latexMarkerInfo
static QCString extraLatexStyleSheet()
void filterLatexString(TextStream &t, const QCString &str, bool insideTabbing, bool insidePre, bool insideItem, bool insideTable, bool keepSpaces, const bool retainNewline)
static void processEntity(TextStream &t, bool pdfHyperlinks, const char *strForm, const char *strRepl)
static void writeMakeBat()
static void writeDefaultStyleSheet(TextStream &t)
void writeExtraLatexPackages(TextStream &t)
static QCString substituteLatexKeywords(const QCString &file, const QCString &str, const QCString &title)
QCString latexEscapeIndexChars(const QCString &s)
static QCString objectLinkToString(const QCString &ref, const QCString &f, const QCString &anchor, const QCString &text, bool insideTabbing, bool disableLinks)
void writeLatexSpecialFormulaChars(TextStream &t)
QCString latexEscapeLabelName(const QCString &s)
QCString latexEscapePDFString(const QCString &s)
void filterLatexString(TextStream &t, const QCString &str, bool insideTabbing, bool insidePre, bool insideItem, bool insideTable, bool keepSpaces, const bool retainNewline=false)
#define LATEX_STYLE_EXTENSION
QCString convertToLaTeX(const QCString &s, bool insideTabbing, bool keepSpaces=FALSE)
QCString latexEscapeIndexChars(const QCString &s)
QCString latexEscapeLabelName(const QCString &s)
std::ofstream openOutputStream(const QCString &name, bool append=false)
const char * ghostScriptCommand()
OutputCodeDefer< LatexCodeGenerator > LatexCodeGeneratorDefer
Portable versions of functions that are platform dependent.
QCString substitute(const QCString &s, const QCString &src, const QCString &dst)
substitute all occurrences of src in s by dst
Various UTF8 related helper functions.
size_t updateColumnCount(const char *s, size_t col)
void checkBlocks(const QCString &s, const QCString fileName, const SelectionMarkerInfo &markerInfo)
QCString stripPath(const QCString &s)
QCString removeEmptyLines(const QCString &s)
QCString selectBlocks(const QCString &s, const SelectionBlockList &blockList, const SelectionMarkerInfo &markerInfo)
remove disabled blocks and all block markers from s and return the result as a string
QCString substituteKeywords(const QCString &file, const QCString &s, const KeywordSubstitutionList &keywords)
QCString relativePathToRoot(const QCString &name)
void clearSubDirs(const Dir &d)
QCString fileToString(const QCString &name, bool filter, bool isSourceCode)
QCString stripExtensionGeneral(const QCString &fName, const QCString &ext)
void createSubDirs(const Dir &d)
bool checkExtension(const QCString &fName, const QCString &ext)
bool copyFile(const QCString &src, const QCString &dest)
Copies the contents of file with name src to the newly created file with name dest.
A bunch of utility functions.