CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Private Attributes
edm::DocFormatHelper Class Reference

#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

Constructor & Destructor Documentation

edm::DocFormatHelper::DocFormatHelper ( )
inline

Definition at line 19 of file DocFormatHelper.h.

Member Function Documentation

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

Definition at line 34 of file DocFormatHelper.h.

References brief_.

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

34 { return brief_; }
size_t edm::DocFormatHelper::column1 ( ) const
inline
size_t edm::DocFormatHelper::column2 ( ) const
inline
size_t edm::DocFormatHelper::column3 ( ) const
inline
size_t edm::DocFormatHelper::commentWidth ( ) const

Definition at line 123 of file DocFormatHelper.cc.

References lineWidth(), and startColumn2().

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

123  {
124  // Make the length of a comment at least 30 characters
125  // per line, longer if there is more space available
126  size_t width = 30U;
127  if (lineWidth() > startColumn2() + 30U) {
128  width = lineWidth() - startColumn2();
129  }
130  return width;
131  }
int startColumn2() const
size_t lineWidth() const
int edm::DocFormatHelper::counter ( ) const
inline

Definition at line 66 of file DocFormatHelper.h.

References counter_.

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

66 { return counter_; }
void edm::DocFormatHelper::decrementCounter ( )
inline
void edm::DocFormatHelper::incrementCounter ( )
inline
void edm::DocFormatHelper::indent ( std::ostream &  os) const
void edm::DocFormatHelper::indent2 ( std::ostream &  os) const
int edm::DocFormatHelper::indentation ( ) const
inline
void edm::DocFormatHelper::init ( void  )

Definition at line 113 of file DocFormatHelper.cc.

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

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

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

Definition at line 35 of file DocFormatHelper.h.

References lineWidth_.

Referenced by commentWidth().

35 { return lineWidth_; }
static int edm::DocFormatHelper::offsetModuleLabel ( )
inlinestatic

Definition at line 81 of file DocFormatHelper.h.

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

81 { return 2; }
static int edm::DocFormatHelper::offsetSectionContent ( )
inlinestatic
static int edm::DocFormatHelper::offsetTopLevelPSet ( )
inlinestatic

Definition at line 82 of file DocFormatHelper.h.

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

82 { return 2; }
DescriptionParent edm::DocFormatHelper::parent ( void  ) const
inline
int edm::DocFormatHelper::pass ( ) const
inline
std::string const& edm::DocFormatHelper::section ( ) const
inline

Definition at line 43 of file DocFormatHelper.h.

References section_.

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

43 { return section_; }
void edm::DocFormatHelper::setAtLeast1 ( size_t  width)
inline

Definition at line 53 of file DocFormatHelper.h.

References column1_.

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

53  {
54  if (width > column1_)
55  column1_ = width;
56  }
void edm::DocFormatHelper::setAtLeast2 ( size_t  width)
inline

Definition at line 57 of file DocFormatHelper.h.

References column2_.

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

57  {
58  if (width > column2_)
59  column2_ = width;
60  }
void edm::DocFormatHelper::setAtLeast3 ( size_t  width)
inline

Definition at line 61 of file DocFormatHelper.h.

References column3_.

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

61  {
62  if (width > column3_)
63  column3_ = width;
64  }
void edm::DocFormatHelper::setBrief ( bool  value)
inline
void edm::DocFormatHelper::setCounter ( int  value)
inline
void edm::DocFormatHelper::setIndentation ( int  value)
inline
void edm::DocFormatHelper::setLineWidth ( size_t  value)
inline
void edm::DocFormatHelper::setParent ( DescriptionParent  value)
inline
void edm::DocFormatHelper::setPass ( int  value)
inline
void edm::DocFormatHelper::setSection ( std::string const &  value)
inline
int edm::DocFormatHelper::startColumn2 ( ) const
inline
void edm::DocFormatHelper::wrapAndPrintText ( std::ostream &  os,
std::string const &  text,
size_t  indent,
size_t  suggestedWidth 
)
static

Definition at line 97 of file DocFormatHelper.cc.

References indent().

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

100  {
101  size_t pos = text.find_first_of('\n');
102  if (pos == std::string::npos) {
103  // no embedded newlines
104  wrapAndPrintLine(os, text, indent, suggestedWidth);
105  } else {
106  // print the first line.
107  wrapAndPrintLine(os, text.substr(0, pos), indent, suggestedWidth);
108  // print all lines after the first.
109  wrapAndPrintText(os, text.substr(pos + 1), indent, suggestedWidth);
110  }
111  }
static void wrapAndPrintText(std::ostream &os, std::string const &text, size_t indent, size_t suggestedWidth)
tuple text
Definition: runonSM.py:43
void indent(std::ostream &os) const

Member Data Documentation

bool edm::DocFormatHelper::brief_
private

Definition at line 86 of file DocFormatHelper.h.

Referenced by brief(), and setBrief().

size_t edm::DocFormatHelper::column1_
private

Definition at line 95 of file DocFormatHelper.h.

Referenced by column1(), init(), and setAtLeast1().

size_t edm::DocFormatHelper::column2_
private

Definition at line 96 of file DocFormatHelper.h.

Referenced by column2(), init(), and setAtLeast2().

size_t edm::DocFormatHelper::column3_
private

Definition at line 97 of file DocFormatHelper.h.

Referenced by column3(), init(), and setAtLeast3().

int edm::DocFormatHelper::counter_
private

Definition at line 99 of file DocFormatHelper.h.

Referenced by counter(), decrementCounter(), incrementCounter(), init(), and setCounter().

int edm::DocFormatHelper::indentation_
private

Definition at line 88 of file DocFormatHelper.h.

Referenced by indent(), indentation(), and setIndentation().

size_t edm::DocFormatHelper::lineWidth_
private

Definition at line 87 of file DocFormatHelper.h.

Referenced by lineWidth(), and setLineWidth().

DescriptionParent edm::DocFormatHelper::parent_
private

Definition at line 101 of file DocFormatHelper.h.

Referenced by init(), parent(), and setParent().

int edm::DocFormatHelper::pass_
private

Definition at line 93 of file DocFormatHelper.h.

Referenced by init(), pass(), and setPass().

std::string edm::DocFormatHelper::section_
private

Definition at line 91 of file DocFormatHelper.h.

Referenced by init(), section(), and setSection().

size_t edm::DocFormatHelper::startColumn2_
private

Definition at line 89 of file DocFormatHelper.h.

Referenced by indent2(), and startColumn2().