#include <DocFormatHelper.h>

Public Types
enum	DescriptionParent { TOP, OR, XOR, AND, OTHER }
Public Member Functions
bool	brief () const
size_t	column1 () const
size_t	column2 () const
size_t	column3 () const
size_t	commentWidth () const
int	counter () const
void	decrementCounter ()
	DocFormatHelper ()
void	incrementCounter ()
void	indent (std::ostream &os) const
void	indent2 (std::ostream &os) const
int	indentation () const
void	init ()
size_t	lineWidth () const
DescriptionParent	parent () const
int	pass () const
std::string const &	section () const
void	setAtLeast1 (size_t width)
void	setAtLeast2 (size_t width)
void	setAtLeast3 (size_t width)
void	setBrief (bool value)
void	setCounter (int value)
void	setIndentation (int value)
void	setLineWidth (size_t value)
void	setParent (DescriptionParent value)
void	setPass (int value)
void	setSection (std::string const &value)
int	startColumn2 () const
Static Public Member Functions
static int	offsetModuleLabel ()
static int	offsetSectionContent ()
static int	offsetTopLevelPSet ()
static void	wrapAndPrintText (std::ostream &os, std::string const &text, size_t indent, size_t suggestedWidth)
Private Attributes
bool	brief_
size_t	column1_
size_t	column2_
size_t	column3_
int	counter_
int	indentation_
size_t	lineWidth_
DescriptionParent	parent_
int	pass_
std::string	section_
size_t	startColumn2_

Detailed Description

Definition at line 15 of file DocFormatHelper.h.

Member Enumeration Documentation

enum edm::DocFormatHelper::DescriptionParent

Enumerator:

TOP
OR
XOR
AND
OTHER

Definition at line 19 of file DocFormatHelper.h.

                           {
      TOP,
      OR,
      XOR,
      AND,
      OTHER      
    };

Constructor & Destructor Documentation

edm::DocFormatHelper::DocFormatHelper ( ) [inline]

Definition at line 27 of file DocFormatHelper.h.

                      :
      brief_(false),
      lineWidth_(80),
      indentation_(4),
      startColumn2_(24U),
      section_(),
      pass_(0),
      column1_(0),
      column2_(0),
      column3_(0),
      counter_(0),
      parent_(OTHER)
    { }

Member Function Documentation

bool edm::DocFormatHelper::brief ( ) const [inline]

Definition at line 43 of file DocFormatHelper.h.

References brief_.

Referenced by edm::ParameterSetDescription::print(), edm::AllowedLabelsDescriptionBase::print_(), edm::ANDGroupDescription::print_(), edm::EmptyGroupDescription::print_(), edm::ORGroupDescription::print_(), edm::ParameterDescriptionBase::print_(), edm::IfExistsDescription::print_(), edm::ParameterWildcardBase::print_(), edm::XORGroupDescription::print_(), edm::ParameterSwitchBase::printBase(), edm::ParameterDescriptionBase::printDefault_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescriptionBase::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::ParameterDescriptionBase::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

{ return brief_; }

size_t edm::DocFormatHelper::column1 ( ) const [inline]

Definition at line 58 of file DocFormatHelper.h.

References column1_.

Referenced by edm::ParameterDescriptionBase::print_(), edm::ParameterWildcardBase::print_(), and edm::ParameterSwitchBase::printBase().

{ return column1_; }

size_t edm::DocFormatHelper::column2 ( ) const [inline]

Definition at line 59 of file DocFormatHelper.h.

References column2_.

Referenced by edm::ParameterDescriptionBase::print_(), edm::ParameterWildcardBase::print_(), and edm::ParameterSwitchBase::printBase().

{ return column2_; }

size_t edm::DocFormatHelper::column3 ( ) const [inline]

Definition at line 60 of file DocFormatHelper.h.

References column3_.

Referenced by edm::ParameterDescriptionBase::print_(), edm::ParameterWildcardBase::print_(), and edm::ParameterSwitchBase::printBase().

{ return column3_; }

size_t edm::DocFormatHelper::commentWidth ( ) const

Definition at line 125 of file DocFormatHelper.cc.

References lineWidth(), startColumn2(), and tablePrinter::width.

Referenced by edm::AllowedLabelsDescriptionBase::print_(), edm::ANDGroupDescription::print_(), edm::ORGroupDescription::print_(), edm::ParameterDescriptionBase::print_(), edm::IfExistsDescription::print_(), edm::ParameterWildcardBase::print_(), edm::XORGroupDescription::print_(), and edm::ParameterSwitchBase::printBase().

                                             {

    // Make the length of a comment at least 30 characters
    // per line, longer if there is more space available
    size_t width = 30U;
    if (lineWidth() > startColumn2() + 30U) {
      width = lineWidth() - startColumn2();
    }
    return width;
  }

int edm::DocFormatHelper::counter ( ) const [inline]

Definition at line 66 of file DocFormatHelper.h.

References counter_.

Referenced by edm::AllowedLabelsDescriptionBase::print_(), edm::ANDGroupDescription::print_(), edm::ORGroupDescription::print_(), edm::IfExistsDescription::print_(), edm::ParameterWildcardBase::print_(), edm::XORGroupDescription::print_(), edm::ParameterSwitchBase::printBase(), edm::ParameterDescriptionBase::printDefault_(), edm::ParameterDescription< ParameterSetDescription >::printDefault_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::ParameterDescriptionBase::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

{ return counter_; }

void edm::DocFormatHelper::decrementCounter ( ) [inline]

Definition at line 69 of file DocFormatHelper.h.

References counter_.

Referenced by edm::ANDGroupDescription::print_(), edm::ORGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::XORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), and edm::ORGroupDescription::printNestedContent_().

{ --counter_; }

void edm::DocFormatHelper::incrementCounter ( ) [inline]

Definition at line 68 of file DocFormatHelper.h.

References counter_.

Referenced by edm::ParameterDescriptionNode::print(), and edm::ParameterDescriptionNode::printNestedContent().

{ ++counter_; }

void edm::DocFormatHelper::indent ( std::ostream & os ) const

Definition at line 136 of file DocFormatHelper.cc.

References indentation_.

Referenced by edm::ParameterSetDescription::print(), edm::AllowedLabelsDescriptionBase::print_(), edm::ORGroupDescription::print_(), edm::EmptyGroupDescription::print_(), edm::ANDGroupDescription::print_(), edm::ParameterDescriptionBase::print_(), edm::IfExistsDescription::print_(), edm::ParameterWildcardBase::print_(), edm::XORGroupDescription::print_(), edm::ParameterSwitchBase::printBase(), edm::ParameterSwitch< T >::printNestedContent_(), edm::AllowedLabelsDescriptionBase::printNestedContentBase_(), and wrapAndPrintText().

                                                   {
    char oldFill = os.fill();
    os << std::setfill(' ') << std::setw(indentation_) << "";
    os.fill(oldFill);
  }

void edm::DocFormatHelper::indent2 ( std::ostream & os ) const

Definition at line 142 of file DocFormatHelper.cc.

References startColumn2_.

Referenced by edm::AllowedLabelsDescriptionBase::print_(), edm::ANDGroupDescription::print_(), edm::ORGroupDescription::print_(), edm::ParameterDescriptionBase::print_(), edm::IfExistsDescription::print_(), edm::ParameterWildcardBase::print_(), edm::XORGroupDescription::print_(), edm::ParameterSwitchBase::printBase(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

                                                    {
    char oldFill = os.fill();
    os << std::setfill(' ') << std::setw(startColumn2_) << "";
    os.fill(oldFill);
  }

int edm::DocFormatHelper::indentation ( ) const [inline]

Definition at line 45 of file DocFormatHelper.h.

References indentation_.

Referenced by edm::ParameterDescriptionBase::printDefault_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::ParameterDescriptionBase::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

{ return indentation_; }

void edm::DocFormatHelper::init ( void )

Definition at line 115 of file DocFormatHelper.cc.

References column1_, column2_, column3_, counter_, OTHER, parent_, pass_, and section_.

Referenced by edm::XORGroupDescription::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

                             {
    section_ = std::string();
    pass_ = 0;
    column1_ = 0;
    column2_ = 0;
    column3_ = 0;
    counter_ = 0;
    parent_ = OTHER;
  }

size_t edm::DocFormatHelper::lineWidth ( ) const [inline]

Definition at line 44 of file DocFormatHelper.h.

References lineWidth_.

Referenced by commentWidth().

{ return lineWidth_; }

static int edm::DocFormatHelper::offsetModuleLabel ( ) [inline, static]

Definition at line 84 of file DocFormatHelper.h.

Referenced by edm::ConfigurationDescriptions::print().

{ return 2; }

static int edm::DocFormatHelper::offsetSectionContent ( ) [inline, static]

Definition at line 86 of file DocFormatHelper.h.

{ return 4; }

static int edm::DocFormatHelper::offsetTopLevelPSet ( ) [inline, static]

Definition at line 85 of file DocFormatHelper.h.

Referenced by edm::ConfigurationDescriptions::printForLabel().

{ return 2; }

DescriptionParent edm::DocFormatHelper::parent ( void ) const [inline]

Definition at line 71 of file DocFormatHelper.h.

References parent_.

Referenced by edm::ANDGroupDescription::print_(), edm::ORGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::ParameterDescriptionBase::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

{ return parent_; }

int edm::DocFormatHelper::pass ( ) const [inline]

Definition at line 55 of file DocFormatHelper.h.

References pass_.

Referenced by edm::AllowedLabelsDescriptionBase::print_(), edm::ANDGroupDescription::print_(), edm::EmptyGroupDescription::print_(), edm::ORGroupDescription::print_(), edm::ParameterDescriptionBase::print_(), edm::IfExistsDescription::print_(), edm::ParameterWildcardBase::print_(), edm::XORGroupDescription::print_(), edm::ParameterSwitchBase::printBase(), and edm::ParameterSetDescription::printNode().

{ return pass_; }

std::string const& edm::DocFormatHelper::section ( ) const [inline]

Definition at line 52 of file DocFormatHelper.h.

References section_.

{ return section_; }

void edm::DocFormatHelper::setAtLeast1 ( size_t width ) [inline]

Definition at line 62 of file DocFormatHelper.h.

References column1_, and tablePrinter::width.

Referenced by edm::ParameterDescriptionBase::print_(), edm::ParameterWildcardBase::print_(), and edm::ParameterSwitchBase::printBase().

{ if (width > column1_) column1_ = width; }

void edm::DocFormatHelper::setAtLeast2 ( size_t width ) [inline]

Definition at line 63 of file DocFormatHelper.h.

References column2_, and tablePrinter::width.

Referenced by edm::ParameterDescriptionBase::print_(), edm::ParameterWildcardBase::print_(), and edm::ParameterSwitchBase::printBase().

{ if (width > column2_) column2_ = width; }

void edm::DocFormatHelper::setAtLeast3 ( size_t width ) [inline]

Definition at line 64 of file DocFormatHelper.h.

References column3_, and tablePrinter::width.

Referenced by edm::ParameterDescriptionBase::print_(), edm::ParameterWildcardBase::print_(), and edm::ParameterSwitchBase::printBase().

{ if (width > column3_) column3_ = width; }

void edm::DocFormatHelper::setBrief ( bool value ) [inline]

Definition at line 48 of file DocFormatHelper.h.

References brief_, and relativeConstraints::value.

Referenced by edm::ConfigurationDescriptions::printForLabel().

{ brief_ = value; }

void edm::DocFormatHelper::setCounter ( int value ) [inline]

Definition at line 67 of file DocFormatHelper.h.

References counter_, and relativeConstraints::value.

Referenced by edm::ParameterSetDescription::print(), edm::XORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::ParameterSwitch< T >::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), and edm::ORGroupDescription::printNestedContent_().

{ counter_ = value; }

void edm::DocFormatHelper::setIndentation ( int value ) [inline]

Definition at line 50 of file DocFormatHelper.h.

References indentation_, and relativeConstraints::value.

{ indentation_ = value; }

void edm::DocFormatHelper::setLineWidth ( size_t value ) [inline]

Definition at line 49 of file DocFormatHelper.h.

References lineWidth_, and relativeConstraints::value.

Referenced by edm::ConfigurationDescriptions::printForLabel().

{ lineWidth_ = value; }

void edm::DocFormatHelper::setParent ( DescriptionParent value ) [inline]

Definition at line 72 of file DocFormatHelper.h.

References parent_, and relativeConstraints::value.

Referenced by edm::ConfigurationDescriptions::printForLabel(), edm::XORGroupDescription::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::AllowedLabelsDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::ParameterWildcard< std::vector< ParameterSet > >::printNestedContent_(), and edm::ParameterSwitchBase::printNestedContentBase().

{ parent_ = value; }

void edm::DocFormatHelper::setPass ( int value ) [inline]

Definition at line 56 of file DocFormatHelper.h.

References pass_, and relativeConstraints::value.

Referenced by edm::ParameterSetDescription::print(), edm::XORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::ParameterSwitch< T >::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), and edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

{ pass_ = value; }

void edm::DocFormatHelper::setSection ( std::string const & value ) [inline]

Definition at line 53 of file DocFormatHelper.h.

References section_, and relativeConstraints::value.

{ section_ = value; }

int edm::DocFormatHelper::startColumn2 ( ) const [inline]

Definition at line 46 of file DocFormatHelper.h.

References startColumn2_.

Referenced by commentWidth(), edm::AllowedLabelsDescriptionBase::print_(), edm::ANDGroupDescription::print_(), edm::ORGroupDescription::print_(), edm::ParameterDescriptionBase::print_(), edm::IfExistsDescription::print_(), edm::ParameterWildcardBase::print_(), edm::XORGroupDescription::print_(), edm::ParameterSwitchBase::printBase(), and edm::ParameterDescriptionBase::printDefault_().

{ return startColumn2_; }

void edm::DocFormatHelper::wrapAndPrintText	(	std::ostream &	os,
		std::string const &	text,
		size_t	indent,
		size_t	suggestedWidth
	)		`[static]`

Definition at line 98 of file DocFormatHelper.cc.

References indent().

Referenced by edm::ConfigurationDescriptions::print(), edm::AllowedLabelsDescriptionBase::print_(), edm::ANDGroupDescription::print_(), edm::ORGroupDescription::print_(), edm::ParameterDescriptionBase::print_(), edm::IfExistsDescription::print_(), edm::ParameterWildcardBase::print_(), edm::XORGroupDescription::print_(), edm::ParameterSwitchBase::printBase(), and edm::ConfigurationDescriptions::printForLabel().

                                                                {

    size_t pos = text.find_first_of('\n');
    if (pos == std::string::npos) {
      // no embedded newlines
      wrapAndPrintLine(os, text, indent, suggestedWidth);
    } else {
      // print the first line.
      wrapAndPrintLine(os, text.substr(0, pos), indent, suggestedWidth);
      // print all lines after the first.
      wrapAndPrintText(os, text.substr(pos + 1), indent, suggestedWidth);
    }
  }