Doxygen
Loading...
Searching...
No Matches
latexgen.h File Reference
#include "config.h"
#include "outputgen.h"
Include dependency graph for latexgen.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  LatexCodeGenerator
 Generator for LaTeX code fragments. More...
class  LatexGenerator
 Generator for LaTeX output. More...

Macros

#define LATEX_STYLE_EXTENSION   ".sty"

Functions

void writeExtraLatexPackages (TextStream &t)
void writeLatexSpecialFormulaChars (TextStream &t)
QCString convertToLaTeX (const QCString &s, bool insideTabbing, bool keepSpaces=FALSE)
void filterLatexString (TextStream &t, const QCString &str, bool insideTabbing, bool insidePre, bool insideItem, bool insideTable, bool keepSpaces, const bool retainNewline=false)
QCString latexEscapeLabelName (const QCString &s)
QCString latexEscapeIndexChars (const QCString &s)
QCString latexEscapePDFString (const QCString &s)
QCString latexFilterURL (const QCString &s)
void latexWriteIndexItem (TextStream &t, const QCString &r1, const QCString &s2="")

Macro Definition Documentation

◆ LATEX_STYLE_EXTENSION

#define LATEX_STYLE_EXTENSION   ".sty"

Definition at line 22 of file latexgen.h.

Referenced by copyLatexStyleSheet(), and extraLatexStyleSheet().

Function Documentation

◆ convertToLaTeX()

QCString convertToLaTeX ( const QCString & s,
bool insideTabbing,
bool keepSpaces = FALSE )

Definition at line 2523 of file latexgen.cpp.

2524{
2525 TextStream t;
2526 filterLatexString(t,s,insideTabbing,false,false,false,keepSpaces);
2527 return t.str();
2528}
TextStream
Text streaming class that buffers data.
Definition textstream.h:36
TextStream::str
std::string str() const
Return the contents of the buffer as a std::string object.
Definition textstream.h:216
filterLatexString
void filterLatexString(TextStream &t, const QCString &str, bool insideTabbing, bool insidePre, bool insideItem, bool insideTable, bool keepSpaces, const bool retainNewline)
Definition latexgen.cpp:2353

References filterLatexString(), and TextStream::str().

Referenced by LatexGenerator::endIndexSection(), objectLinkToString(), LatexGenerator::startIndexSection(), substituteLatexKeywords(), and LatexGenerator::writeInheritedSectionTitle().

◆ filterLatexString()

void filterLatexString ( TextStream & t,
const QCString & str,
bool insideTabbing,
bool insidePre,
bool insideItem,
bool insideTable,
bool keepSpaces,
const bool retainNewline = false )

Definition at line 2353 of file latexgen.cpp.

2355{
2356 if (str.isEmpty()) return;
2357 bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
2358 //printf("filterLatexString(%s) insideTabbing=%d\n",qPrint(str),insideTabbing);
2359 const char *p = str.data();
2360 const char *q = nullptr;
2361 unsigned char pc='\0';
2362
2363 while (*p)
2364 {
2365 unsigned char c=static_cast<unsigned char>(*p++);
2366
2367 if (insidePre)
2368 {
2369 switch(c)
2370 {
2371 case 0xef: // handle U+FFFD i.e. "Replacement character" caused by octal: 357 277 275 / hexadecimal 0xef 0xbf 0xbd
2372 // the LaTeX command \ucr has been defined in doxygen.sty
2373 if (static_cast<unsigned char>(*(p)) == 0xbf && static_cast<unsigned char>(*(p+1)) == 0xbd)
2374 {
2375 t << "{\\ucr}";
2376 p += 2;
2377 }
2378 else
2379 t << static_cast<char>(c);
2380 break;
2381 case '\\': t << "\\(\\backslash\\)"; break;
2382 case '{': t << "\\{"; break;
2383 case '}': t << "\\}"; break;
2384 case '_': t << "\\_"; break;
2385 case '&': t << "\\&"; break;
2386 case '%': t << "\\%"; break;
2387 case '#': t << "\\#"; break;
2388 case '$': t << "\\$"; break;
2389 case '"': t << "\"{}"; break;
2390 case '-': t << "-\\/"; break;
2391 case '^': insideTable ? t << "\\string^" : t << static_cast<char>(c); break;
2392 case '~': t << "\\string~"; break;
2393 case '\n': if (retainNewline) t << "\\newline"; else t << ' ';
2394 break;
2395 case ' ': if (keepSpaces) t << "~"; else t << ' ';
2396 break;
2397 default:
2398 if (c<32) t << ' '; // non printable control character
2399 else t << static_cast<char>(c);
2400 break;
2401 }
2402 }
2403 else
2404 {
2405 switch(c)
2406 {
2407 case 0xef: // handle U+FFFD i.e. "Replacement character" caused by octal: 357 277 275 / hexadecimal 0xef 0xbf 0xbd
2408 // the LaTeX command \ucr has been defined in doxygen.sty
2409 if (static_cast<unsigned char>(*(p)) == 0xbf && static_cast<unsigned char>(*(p+1)) == 0xbd)
2410 {
2411 t << "{\\ucr}";
2412 p += 2;
2413 }
2414 else
2415 t << static_cast<char>(c);
2416 break;
2417 case '#': t << "\\+\\#"; break;
2418 case '$': t << "\\$"; break;
2419 case '%': t << "\\%"; break;
2420 case '^': processEntity(t,pdfHyperlinks,"$^\\wedge$","\\string^"); break;
2421 case '&': {
2422 // possibility to have a special symbol
2423 q = p;
2424 int cnt = 2; // we have to count & and ; as well
2425 while ((*q >= 'a' && *q <= 'z') || (*q >= 'A' && *q <= 'Z') || (*q >= '0' && *q <= '9'))
2426 {
2427 cnt++;
2428 q++;
2429 }
2430 if (*q == ';')
2431 {
2432 --p; // we need & as well
2433 HtmlEntityMapper::SymType res = HtmlEntityMapper::instance().name2sym(QCString(p).left(cnt));
2434 if (res == HtmlEntityMapper::Sym_Unknown)
2435 {
2436 p++;
2437 t << "\\&";
2438 }
2439 else
2440 {
2441 t << HtmlEntityMapper::instance().latex(res);
2442 q++;
2443 p = q;
2444 }
2445 }
2446 else
2447 {
2448 t << "\\&";
2449 }
2450 }
2451 break;
2452 case '*': processEntity(t,pdfHyperlinks,"$\\ast$","*"); break;
2453 case '_': if (!insideTabbing) t << "\\+";
2454 t << "\\_";
2455 if (!insideTabbing) t << "\\+";
2456 break;
2457 case '{': t << "\\{"; break;
2458 case '}': t << "\\}"; break;
2459 case '<': t << "$<$"; break;
2460 case '>': t << "$>$"; break;
2461 case '|': processEntity(t,pdfHyperlinks,"$\\vert$","|"); break;
2462 case '~': processEntity(t,pdfHyperlinks,"$\\sim$","\\string~"); break;
2463 case '[': if (Config_getBool(PDF_HYPERLINKS) || insideItem)
2464 t << "\\+[";
2465 else
2466 t << "[";
2467 break;
2468 case ']': if (pc=='[') t << "$\\,$";
2469 if (Config_getBool(PDF_HYPERLINKS) || insideItem)
2470 t << "]\\+";
2471 else
2472 t << "]";
2473 break;
2474 case '-': t << "-\\/";
2475 break;
2476 case '\\': t << "\\textbackslash{}";
2477 break;
2478 case '"': t << "\"{}";
2479 break;
2480 case '`': t << "\\`{}";
2481 break;
2482 case '\'': t << "\\textquotesingle{}";
2483 break;
2484 case '\n': if (retainNewline)
2485 {
2486 t << "\\newline";
2487 if (insideTable) t << " ";
2488 }
2489 else
2490 {
2491 t << ' ';
2492 }
2493 break;
2494 case ' ': if (keepSpaces) { if (insideTabbing) t << "\\>"; else t << '~'; } else t << ' ';
2495 break;
2496
2497 default:
2498 //if (!insideTabbing && forceBreaks && c!=' ' && *p!=' ')
2499 if (!insideTabbing &&
2500 ((c>='A' && c<='Z' && pc!=' ' && !(pc>='A' && pc <= 'Z') && pc!='\0' && *p) || (pc=='.' && isId(c)))
2501 )
2502 {
2503 t << "\\+";
2504 }
2505 if (c<32)
2506 {
2507 t << ' '; // non-printable control character
2508 }
2509 else
2510 {
2511 t << static_cast<char>(c);
2512 }
2513 if (!insideTabbing && ((c==':' && *p!=':') || c=='/'))
2514 {
2515 t << "\\+";
2516 }
2517 }
2518 }
2519 pc = c;
2520 }
2521}
HtmlEntityMapper::latex
const char * latex(SymType symb) const
Access routine to the LaTeX code of the HTML entity.
Definition htmlentity.cpp:413
HtmlEntityMapper::instance
static HtmlEntityMapper & instance()
Returns the one and only instance of the HTML entity mapper.
Definition htmlentity.cpp:339
HtmlEntityMapper::name2sym
SymType name2sym(const QCString &symName) const
Give code of the requested HTML entity name.
Definition htmlentity.cpp:458
QCString
This is an alternative implementation of QCString.
Definition qcstring.h:101
QCString::isEmpty
bool isEmpty() const
Returns TRUE iff the string is empty.
Definition qcstring.h:163
QCString::data
const char * data() const
Returns a pointer to the contents of the string in the form of a 0-terminated C string.
Definition qcstring.h:172
Config_getBool
#define Config_getBool(name)
Definition config.h:33
insideTable
bool insideTable(const DocNodeVariant *n)
Definition docparser_p.h:253
processEntity
static void processEntity(TextStream &t, bool pdfHyperlinks, const char *strForm, const char *strRepl)
Definition latexgen.cpp:1429
isId
bool isId(int c)
Definition util.h:256

References Config_getBool, QCString::data(), insideTable(), HtmlEntityMapper::instance(), QCString::isEmpty(), isId(), HtmlEntityMapper::latex(), HtmlEntityMapper::name2sym(), processEntity(), and HtmlEntityMapper::Sym_Unknown.

Referenced by LatexCodeGenerator::codify(), convertToLaTeX(), LatexGenerator::docify(), LatexDocVisitor::filter(), latexEscapeIndexChars(), latexEscapeLabelName(), and substituteLatexKeywords().

◆ latexEscapeIndexChars()

QCString latexEscapeIndexChars ( const QCString & s)

Definition at line 2575 of file latexgen.cpp.

2576{
2577 //printf("latexEscapeIndexChars(%s)\n",qPrint(s));
2578 if (s.isEmpty()) return s;
2579 QCString tmp(s.length(), QCString::ExplicitSize);
2580 TextStream t;
2581 const char *p=s.data();
2582 char c = 0;
2583 while ((c=*p++))
2584 {
2585 switch (c)
2586 {
2587 case '!': t << "\"!"; break;
2588 case '"': t << "\"\""; break;
2589 case '@': t << "\"@"; break;
2590 case '|': t << "\\texttt{\"|}"; break;
2591 case '[': t << "["; break;
2592 case ']': t << "]"; break;
2593 case '{': t << "\\lcurly{}"; break;
2594 case '}': t << "\\rcurly{}"; break;
2595 // NOTE: adding a case here, means adding it to while below as well!
2596 default:
2597 {
2598 int i=0;
2599 // collect as long string as possible, before handing it to docify
2600 tmp[i++]=c;
2601 while ((c=*p) && c!='"' && c!='@' && c!='[' && c!=']' && c!='!' && c!='{' && c!='}' && c!='|')
2602 {
2603 tmp[i++]=c;
2604 p++;
2605 }
2606 tmp[i]=0;
2607 filterLatexString(t,tmp,
2608 true, // insideTabbing
2609 false, // insidePre
2610 false, // insideItem
2611 false, // insideTable
2612 false // keepSpaces
2613 );
2614 }
2615 break;
2616 }
2617 }
2618 return t.str();
2619}
QCString::length
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition qcstring.h:166
QCString::ExplicitSize
@ ExplicitSize
Definition qcstring.h:146

References QCString::data(), QCString::ExplicitSize, filterLatexString(), QCString::isEmpty(), QCString::length(), and TextStream::str().

Referenced by latexWriteIndexItem(), and LatexGenerator::startMemberDoc().

◆ latexEscapeLabelName()

QCString latexEscapeLabelName ( const QCString & s)

Definition at line 2530 of file latexgen.cpp.

2531{
2532 //printf("latexEscapeLabelName(%s)\n",qPrint(s));
2533 if (s.isEmpty()) return s;
2534 QCString tmp(s.length(), QCString::ExplicitSize);
2535 TextStream t;
2536 const char *p=s.data();
2537 char c = 0;
2538 while ((c=*p++))
2539 {
2540 switch (c)
2541 {
2542 case '|': t << "\\texttt{\"|}"; break;
2543 case '!': t << "\"!"; break;
2544 case '@': t << "\"@"; break;
2545 case '%': t << "\\%"; break;
2546 case '{': t << "\\lcurly{}"; break;
2547 case '}': t << "\\rcurly{}"; break;
2548 case '~': t << "````~"; break; // to get it a bit better in index together with other special characters
2549 // NOTE: adding a case here, means adding it to while below as well!
2550 default:
2551 {
2552 int i=0;
2553 // collect as long string as possible, before handing it to docify
2554 tmp[i++]=c;
2555 while ((c=*p) && c!='@' && c!='[' && c!=']' && c!='!' && c!='{' && c!='}' && c!='|')
2556 {
2557 tmp[i++]=c;
2558 p++;
2559 }
2560 tmp[i]=0;
2561 filterLatexString(t,tmp,
2562 true, // insideTabbing
2563 false, // insidePre
2564 false, // insideItem
2565 false, // insideTable
2566 false // keepSpaces
2567 );
2568 }
2569 break;
2570 }
2571 }
2572 return t.str();
2573}

References QCString::data(), QCString::ExplicitSize, filterLatexString(), QCString::isEmpty(), QCString::length(), and TextStream::str().

Referenced by latexWriteIndexItem().

◆ latexEscapePDFString()

QCString latexEscapePDFString ( const QCString & s)

Definition at line 2621 of file latexgen.cpp.

2622{
2623 if (s.isEmpty()) return s;
2624 TextStream t;
2625 const char *p=s.data();
2626 char c = 0;
2627 while ((c=*p++))
2628 {
2629 switch (c)
2630 {
2631 case '\\': t << "\\textbackslash{}"; break;
2632 case '{': t << "\\{"; break;
2633 case '}': t << "\\}"; break;
2634 case '_': t << "\\_"; break;
2635 case '%': t << "\\%"; break;
2636 case '&': t << "\\&"; break;
2637 case '#': t << "\\#"; break;
2638 case '$': t << "\\$"; break;
2639 case '^': t << "\\string^"; break;
2640 case '~': t << "\\string~"; break;
2641 default:
2642 t << c;
2643 break;
2644 }
2645 }
2646 return t.str();
2647}

References QCString::data(), QCString::isEmpty(), and TextStream::str().

Referenced by LatexGenerator::startMemberDoc().

◆ latexFilterURL()

QCString latexFilterURL ( const QCString & s)

Definition at line 2649 of file latexgen.cpp.

2650{
2651 constexpr auto hex = "0123456789ABCDEF";
2652 if (s.isEmpty()) return s;
2653 TextStream t;
2654 const char *p=s.data();
2655 char c = 0;
2656 while ((c=*p++))
2657 {
2658 switch (c)
2659 {
2660 case '#': t << "\\#"; break;
2661 case '%': t << "\\%"; break;
2662 case '\\': t << "\\\\"; break;
2663 case '\n': break; // ignore
2664 default:
2665 if (c<0)
2666 {
2667 unsigned char id = static_cast<unsigned char>(c);
2668 t << "\\%" << hex[id>>4] << hex[id&0xF];
2669 }
2670 else
2671 {
2672 t << c;
2673 }
2674 break;
2675 }
2676 }
2677 return t.str();
2678}
hex
static constexpr auto hex
Definition docbookgen.cpp:1481

References QCString::data(), hex, QCString::isEmpty(), and TextStream::str().

Referenced by LatexDocVisitor::operator()(), and LatexDocVisitor::operator()().

◆ latexWriteIndexItem()

void latexWriteIndexItem ( TextStream & t,
const QCString & r1,
const QCString & s2 = "" )

Definition at line 2680 of file latexgen.cpp.

2681{
2682 if (!s1.isEmpty())
2683 {
2684 m_t << "\\index{";
2685 m_t << latexEscapeLabelName(s1);
2686 m_t << "@{";
2687 m_t << latexEscapeIndexChars(s1);
2688 m_t << "}";
2689 if (!s2.isEmpty())
2690 {
2691 m_t << "!";
2692 m_t << latexEscapeLabelName(s2);
2693 m_t << "@{";
2694 m_t << latexEscapeIndexChars(s2);
2695 m_t << "}";
2696 }
2697 m_t << "}\n";
2698 }
2699}
latexEscapeIndexChars
QCString latexEscapeIndexChars(const QCString &s)
Definition latexgen.cpp:2575
latexEscapeLabelName
QCString latexEscapeLabelName(const QCString &s)
Definition latexgen.cpp:2530

References QCString::isEmpty(), latexEscapeIndexChars(), and latexEscapeLabelName().

Referenced by LatexGenerator::addIndexItem(), LatexGenerator::endTitleHead(), LatexDocVisitor::operator()(), and LatexGenerator::startMemberDoc().

◆ writeExtraLatexPackages()

void writeExtraLatexPackages ( TextStream & t)

Definition at line 2292 of file latexgen.cpp.

2293{
2294 // User-specified packages
2295 const StringVector &extraPackages = Config_getList(EXTRA_PACKAGES);
2296 if (!extraPackages.empty())
2297 {
2298 t << "% Packages requested by user\n";
2299 for (const auto &pkgName : extraPackages)
2300 {
2301 if ((pkgName[0] == '[') || (pkgName[0] == '{'))
2302 t << "\\usepackage" << pkgName << "\n";
2303 else
2304 t << "\\usepackage{" << pkgName << "}\n";
2305 }
2306 t << "\n";
2307 }
2308}
Config_getList
#define Config_getList(name)
Definition config.h:38
StringVector
std::vector< std::string > StringVector
Definition containers.h:33

References Config_getList.

Referenced by FormulaManager::createLatexFile(), and substituteLatexKeywords().

◆ writeLatexSpecialFormulaChars()

void writeLatexSpecialFormulaChars ( TextStream & t)

Definition at line 2310 of file latexgen.cpp.

2311{
2312 unsigned char minus[4]; // Superscript minus
2313 unsigned char sup2[3]; // Superscript two
2314 unsigned char sup3[3];
2315 minus[0]= 0xE2;
2316 minus[1]= 0x81;
2317 minus[2]= 0xBB;
2318 minus[3]= 0;
2319 sup2[0]= 0xC2;
2320 sup2[1]= 0xB2;
2321 sup2[2]= 0;
2322 sup3[0]= 0xC2;
2323 sup3[1]= 0xB3;
2324 sup3[2]= 0;
2325
2326 t << "\\ifPDFTeX\n";
2327 t << "\\usepackage{newunicodechar}\n";
2328 // taken from the newunicodechar package and removed the warning message
2329 // actually forcing to redefine the unicode character
2330 t << " \\makeatletter\n"
2331 " \\def\\doxynewunicodechar#1#2{%\n"
2332 " \\@tempswafalse\n"
2333 " \\edef\\nuc@tempa{\\detokenize{#1}}%\n"
2334 " \\if\\relax\\nuc@tempa\\relax\n"
2335 " \\nuc@emptyargerr\n"
2336 " \\else\n"
2337 " \\edef\\@tempb{\\expandafter\\@car\\nuc@tempa\\@nil}%\n"
2338 " \\nuc@check\n"
2339 " \\if@tempswa\n"
2340 " \\@namedef{u8:\\nuc@tempa}{#2}%\n"
2341 " \\fi\n"
2342 " \\fi\n"
2343 " }\n"
2344 " \\makeatother\n";
2345
2346 t << " \\doxynewunicodechar{" << minus << "}{${}^{-}$}% Superscript minus\n"
2347 " \\doxynewunicodechar{" << sup2 << "}{${}^{2}$}% Superscript two\n"
2348 " \\doxynewunicodechar{" << sup3 << "}{${}^{3}$}% Superscript three\n"
2349 "\n";
2350 t << "\\fi\n";
2351}

Referenced by FormulaManager::createLatexFile(), and substituteLatexKeywords().