#################################################################################################################################### # DOC LATEX SECTION MODULE #################################################################################################################################### package BackRestDoc::Latex::DocLatexSection; use parent 'BackRestDoc::Common::DocExecute'; use strict; use warnings FATAL => qw(all); use Carp qw(confess); use Exporter qw(import); our @EXPORT = qw(); use pgBackRest::Common::Ini; use pgBackRest::Common::Log; use pgBackRest::Common::String; use pgBackRest::Config::ConfigHelp; use pgBackRest::FileCommon; use BackRestDoc::Common::DocManifest; #################################################################################################################################### # CONSTRUCTOR #################################################################################################################################### sub new { my $class = shift; # Class name # Assign function parameters, defaults, and log debug info my ( $strOperation, $oManifest, $strRenderOutKey, $bExe ) = logDebugParam ( __PACKAGE__ . '->new', \@_, {name => 'oManifest'}, {name => 'strRenderOutKey'}, {name => 'bExe'} ); # Create the class hash my $self = $class->SUPER::new('latex', $oManifest, $strRenderOutKey, $bExe); bless $self, $class; # Return from function and log return values if any return logDebugReturn ( $strOperation, {name => 'self', value => $self} ); } #################################################################################################################################### # process # # Generate the site html #################################################################################################################################### sub process { my $self = shift; # Assign function parameters, defaults, and log debug info my $strOperation = logDebugParam(__PACKAGE__ . '->process'); # Working variables my $oPage = $self->{oDoc}; my $strLatex; # Initialize page my $strTitle = $oPage->paramGet('title'); my $strSubTitle = $oPage->paramGet('subtitle', false); # Render sections foreach my $oSection ($oPage->nodeList('section')) { $strLatex .= (defined($strLatex) ? "\n" : '') . $self->sectionProcess($oSection, undef, 1); } # Return from function and log return values if any return logDebugReturn ( $strOperation, {name => 'strHtml', value => $strLatex, trace => true} ); } #################################################################################################################################### # sectionProcess #################################################################################################################################### sub sectionProcess { my $self = shift; # Assign function parameters, defaults, and log debug info my ( $strOperation, $oSection, $strSection, $iDepth ) = logDebugParam ( __PACKAGE__ . '->sectionRender', \@_, {name => 'oSection'}, {name => 'strSection', required => false}, {name => 'iDepth'} ); &log($iDepth == 1 ? INFO : DEBUG, (' ' x ($iDepth + 1)) . 'process section: ' . $oSection->paramGet('id')); # Create the section my $strSectionTitle = $self->processText($oSection->nodeGet('title')->textGet()); $strSection .= (defined($strSection) ? ', ' : '') . "'${strSectionTitle}' " . ('Sub' x ($iDepth - 1)) . "Section"; my $strLatex = "% ${strSection}\n% " . ('-' x 130) . "\n\\"; if ($iDepth <= 3) { $strLatex .= ($iDepth > 1 ? ('sub' x ($iDepth - 1)) : '') . "section"; } elsif ($iDepth == 4) { $strLatex .= 'paragraph'; } else { confess &log(ASSERT, "section depth of ${iDepth} exceeds maximum"); } $strLatex .= "\{${strSectionTitle}\}\\label{" . $oSection->paramGet('path', false) . "}\n"; foreach my $oChild ($oSection->nodeList()) { &log(DEBUG, (' ' x ($iDepth + 2)) . 'process child ' . $oChild->nameGet()); # Execute a command if ($oChild->nameGet() eq 'execute-list') { my $strHostName = $self->{oManifest}->variableReplace($oChild->paramGet('host')); $strLatex .= "\n\\begin\{lstlisting\}[title=\{\\textnormal{\\textbf\{${strHostName}}} --- " . $self->processText($oChild->nodeGet('title')->textGet()) . "}]\n"; foreach my $oExecute ($oChild->nodeList('execute')) { my $bExeShow = !$oExecute->paramTest('show', 'n'); my ($strCommand, $strOutput) = $self->execute($oSection, $self->{oManifest}->variableReplace($oChild->paramGet('host')), $oExecute, $iDepth + 3); if ($bExeShow) { $strLatex .= "${strCommand}\n"; if (defined($strOutput)) { $strLatex .= "\nOutput:\n\n${strOutput}\n"; } } } $strLatex .= "\\end{lstlisting}\n"; } # Add code block elsif ($oChild->nameGet() eq 'code-block') { my $strTitle = $oChild->paramGet("title", false); if (defined($strTitle) && $strTitle eq '') { undef($strTitle) } # Begin the code listing if (!defined($strTitle)) { $strLatex .= "\\vspace{.75em}\n"; } $strLatex .= "\\begin\{lstlisting\}"; # Add the title if one is provided if (defined($strTitle)) { $strLatex .= "[title=\{${strTitle}:\}]"; } # End the code listing $strLatex .= "\n" . trim($oChild->valueGet()) . "\n" . "\\end{lstlisting}\n"; } # Add table elsif ($oChild->nameGet() eq 'table') { my $oHeader = $oChild->nodeGet('table-header'); my @oyColumn = $oHeader->nodeList('table-column'); my $strWidth = '{' . ($oHeader->paramTest('width') ? $oHeader->paramGet('width') : '\textwidth') . '}'; # Build the table header $strLatex .= "\\vspace{1em}\\newline\n"; $strLatex .= "\\begin{tabularx}${strWidth}{ | "; foreach my $oColumn (@oyColumn) { my $strAlignCode; my $strAlign = $oColumn->paramGet("align", false); if ($oColumn->paramTest('fill', 'y')) { if (!defined($strAlign) || $strAlign eq 'left') { $strAlignCode = 'X'; } elsif ($strAlign eq 'right') { $strAlignCode = 'R'; } else { confess &log(ERROR, "align '${strAlign}' not valid when fill=y"); } } else { if (!defined($strAlign) || $strAlign eq 'left') { $strAlignCode = 'l'; } elsif ($strAlign eq 'center') { $strAlignCode = 'c'; } elsif ($strAlign eq 'right') { $strAlignCode = 'r'; } else { confess &log(ERROR, "align '${strAlign}' not valid"); } } # $strLatex .= 'p{' . $oColumn->paramGet("width") . '} | '; $strLatex .= $strAlignCode . ' | '; } $strLatex .= "}\n"; if ($oChild->nodeGet("title", false)) { $strLatex .= "\\caption{" . $self->processText($oChild->nodeGet("title")->textGet()) . ":}\\\\\n"; } $strLatex .= "\\hline"; $strLatex .= "\\rowcolor{ltgray}\n"; my $strLine; foreach my $oColumn (@oyColumn) { $strLine .= (defined($strLine) ? ' & ' : '') . '\textbf{' . $self->processText($oColumn->textGet()) . '}'; } $strLatex .= "${strLine}\\\\"; # Build the rows foreach my $oRow ($oChild->nodeGet('table-data')->nodeList('table-row')) { $strLatex .= "\\hline\n"; undef($strLine); foreach my $oRowCell ($oRow->nodeList('table-cell')) { $strLine .= (defined($strLine) ? ' & ' : '') . $self->processText($oRowCell->textGet()); } $strLatex .= "${strLine}\\\\"; } $strLatex .= "\\hline\n\\end{tabularx}\n"; } # Add descriptive text elsif ($oChild->nameGet() eq 'p') { $strLatex .= "\n" . $self->processText($oChild->textGet()) . "\n"; } # Add option descriptive text elsif ($oChild->nameGet() eq 'option-description') { my $strOption = $oChild->paramGet("key"); my $oDescription = ${$self->{oReference}->{oConfigHash}}{&CONFIG_HELP_OPTION}{$strOption}{&CONFIG_HELP_DESCRIPTION}; if (!defined($oDescription)) { confess &log(ERROR, "unable to find ${strOption} option in sections - try adding option?"); } $strLatex .= "\n" . $self->processText($oDescription) . "\n"; } # Add cmd descriptive text elsif ($oChild->nameGet() eq 'cmd-description') { my $strCommand = $oChild->paramGet("key"); my $oDescription = ${$self->{oReference}->{oConfigHash}}{&CONFIG_HELP_COMMAND}{$strCommand}{&CONFIG_HELP_DESCRIPTION}; if (!defined($oDescription)) { confess &log(ERROR, "unable to find ${strCommand} command in sections - try adding command?"); } $strLatex .= "\n" . $self->processText($oDescription) . "\n"; } # Add a list elsif ($oChild->nameGet() eq 'list') { $strLatex .= "\n\\begin{itemize}"; foreach my $oListItem ($oChild->nodeList()) { $strLatex .= "\n \\item " . $self->processText($oListItem->textGet()); } $strLatex .= "\n\\end{itemize}"; } # Add/remove config options elsif ($oChild->nameGet() eq 'backrest-config' || $oChild->nameGet() eq 'postgres-config') { $strLatex .= $self->configProcess($oSection, $oChild, $iDepth + 3); } # Add a subsection elsif ($oChild->nameGet() eq 'section') { $strLatex .= "\n" . $self->sectionProcess($oChild, $strSection, $iDepth + 1); } # Check if the child can be processed by a parent else { $self->sectionChildProcess($oSection, $oChild, $iDepth + 1); } } # Return from function and log return values if any return logDebugReturn ( $strOperation, {name => 'strSection', value => $strLatex, trace => true} ); } #################################################################################################################################### # configProcess #################################################################################################################################### sub configProcess { my $self = shift; # Assign function parameters, defaults, and log debug info my ( $strOperation, $oSection, $oConfig, $iDepth ) = logDebugParam ( __PACKAGE__ . '->configProcess', \@_, {name => 'oSection'}, {name => 'oConfig'}, {name => 'iDepth'} ); # Working variables my $strLatex = ''; my $strFile; my $strConfig; my $bShow = true; # Generate the config if ($oConfig->nameGet() eq 'backrest-config') { ($strFile, $strConfig, $bShow) = $self->backrestConfig($oSection, $oConfig, $iDepth); } else { ($strFile, $strConfig, $bShow) = $self->postgresConfig($oSection, $oConfig, $iDepth); } if ($bShow) { my $strHostName = $self->{oManifest}->variableReplace($oConfig->paramGet('host')); # Replace _ in filename $strFile = $self->variableReplace($strFile); # Render the config $strLatex = "\n\\begin\{lstlisting\}[title=\{\\textnormal{\\textbf\{${strHostName}}}:\\textnormal{\\texttt\{${strFile}}} --- " . $self->processText($oConfig->nodeGet('title')->textGet()) . "}]\n" . (defined($strConfig) ? $strConfig : '') . "\\end{lstlisting}\n"; } # Return from function and log return values if any return logDebugReturn ( $strOperation, {name => 'strConfig', value => $strLatex, trace => true} ); } 1;