Logo ROOT   6.21/01
Reference Guide
ROOT::option::PrintUsageImplementation::LinePartIterator Class Reference

Definition at line 1937 of file OptionParser.h.

Public Member Functions

 LinePartIterator (const Descriptor usage[])
 Creates an iterator for usage. More...
 
int column ()
 Returns the index (counting from 0) of the column in which the part pointed to by data() is located. More...
 
const char * data ()
 Returns the current part of the iteration. More...
 
int length ()
 Returns the length of the part pointed to by data() in raw chars (not UTF-8 characters). More...
 
int line ()
 Returns the index (counting from 0) of the line within the current column this part belongs to. More...
 
bool next ()
 Moves iteration to the next part (if any). More...
 
bool nextRow ()
 Moves iteration to the next row (if any). More...
 
bool nextTable ()
 Moves iteration to the next table (if any). More...
 
void restartRow ()
 Reset iteration to the beginning of the current row. More...
 
void restartTable ()
 Reset iteration to the beginning of the current table. More...
 
int screenLength ()
 Returns the width in screen columns of the part pointed to by data(). More...
 

Private Member Functions

void update_length ()
 Determines the byte and character lengths of the part at ptr and stores them in len and screenlen respectively. More...
 

Private Attributes

int col
 Index of current column. More...
 
bool hit_target_line
 Flag whether we encountered a part with line index target_line_in_block in the current cell. More...
 
int len
 Length of the current part (that ptr points at) in BYTES. More...
 
int line_in_block
 Line index within the current cell of the current part. More...
 
int max_line_in_block
 Greatest index of a line within the block. More...
 
const char * ptr
 Ptr to current part within the current row. More...
 
const Descriptorrowdesc
 The Descriptor that contains the current row. More...
 
const char * rowstart
 Ptr to 1st character of current row within rowdesc->help. More...
 
int screenlen
 Length of the current part in screen columns (taking narrow/wide chars into account). More...
 
const Descriptortablestart
 The 1st descriptor of the current table. More...
 
int target_line_in_block
 Line index of the parts we should return to the user on this iteration. More...
 

#include </mnt/build/workspace/root-makedoc/rootspi/rdoc/src/master/core/dictgen/res/OptionParser.h>

Constructor & Destructor Documentation

◆ LinePartIterator()

ROOT::option::PrintUsageImplementation::LinePartIterator::LinePartIterator ( const Descriptor  usage[])
inline

Creates an iterator for usage.

Definition at line 1982 of file OptionParser.h.

Member Function Documentation

◆ column()

int ROOT::option::PrintUsageImplementation::LinePartIterator::column ( )
inline

Returns the index (counting from 0) of the column in which the part pointed to by data() is located.

Definition at line 2148 of file OptionParser.h.

◆ data()

const char* ROOT::option::PrintUsageImplementation::LinePartIterator::data ( )
inline

Returns the current part of the iteration.

Definition at line 2182 of file OptionParser.h.

◆ length()

int ROOT::option::PrintUsageImplementation::LinePartIterator::length ( )
inline

Returns the length of the part pointed to by data() in raw chars (not UTF-8 characters).

Definition at line 2165 of file OptionParser.h.

◆ line()

int ROOT::option::PrintUsageImplementation::LinePartIterator::line ( )
inline

Returns the index (counting from 0) of the line within the current column this part belongs to.

Definition at line 2157 of file OptionParser.h.

◆ next()

bool ROOT::option::PrintUsageImplementation::LinePartIterator::next ( )
inline

Moves iteration to the next part (if any).

Has to be called once after each call to nextRow() to move to the 1st part of the row.

Return values
falseif moving to next part failed because no further part exists.

See LinePartIterator for details about the iteration.

Definition at line 2076 of file OptionParser.h.

◆ nextRow()

bool ROOT::option::PrintUsageImplementation::LinePartIterator::nextRow ( )
inline

Moves iteration to the next row (if any).

Has to be called once after each call to nextTable() to move to the 1st row of the table.

Return values
falseif moving to next row failed because no further row exists.

Definition at line 2026 of file OptionParser.h.

◆ nextTable()

bool ROOT::option::PrintUsageImplementation::LinePartIterator::nextTable ( )
inline

Moves iteration to the next table (if any).

Has to be called once on a new LinePartIterator to move to the 1st table.

Return values
falseif moving to next table failed because no further table exists.

Definition at line 1993 of file OptionParser.h.

◆ restartRow()

void ROOT::option::PrintUsageImplementation::LinePartIterator::restartRow ( )
inline

Reset iteration to the beginning of the current row.

Definition at line 2057 of file OptionParser.h.

◆ restartTable()

void ROOT::option::PrintUsageImplementation::LinePartIterator::restartTable ( )
inline

Reset iteration to the beginning of the current table.

Definition at line 2014 of file OptionParser.h.

◆ screenLength()

int ROOT::option::PrintUsageImplementation::LinePartIterator::screenLength ( )
inline

Returns the width in screen columns of the part pointed to by data().

Takes multi-byte UTF-8 sequences and wide characters into account.

Definition at line 2174 of file OptionParser.h.

◆ update_length()

void ROOT::option::PrintUsageImplementation::LinePartIterator::update_length ( )
inlineprivate

Determines the byte and character lengths of the part at ptr and stores them in len and screenlen respectively.

Definition at line 1955 of file OptionParser.h.

Member Data Documentation

◆ col

int ROOT::option::PrintUsageImplementation::LinePartIterator::col
private

Index of current column.

Definition at line 1943 of file OptionParser.h.

◆ hit_target_line

bool ROOT::option::PrintUsageImplementation::LinePartIterator::hit_target_line
private

Flag whether we encountered a part with line index target_line_in_block in the current cell.

Definition at line 1949 of file OptionParser.h.

◆ len

int ROOT::option::PrintUsageImplementation::LinePartIterator::len
private

Length of the current part (that ptr points at) in BYTES.

Definition at line 1944 of file OptionParser.h.

◆ line_in_block

int ROOT::option::PrintUsageImplementation::LinePartIterator::line_in_block
private

Line index within the current cell of the current part.

Definition at line 1947 of file OptionParser.h.

◆ max_line_in_block

int ROOT::option::PrintUsageImplementation::LinePartIterator::max_line_in_block
private

Greatest index of a line within the block.

This is the number of \v within the cell with the most \vs.

Definition at line 1946 of file OptionParser.h.

◆ ptr

const char* ROOT::option::PrintUsageImplementation::LinePartIterator::ptr
private

Ptr to current part within the current row.

Definition at line 1942 of file OptionParser.h.

◆ rowdesc

const Descriptor* ROOT::option::PrintUsageImplementation::LinePartIterator::rowdesc
private

The Descriptor that contains the current row.

Definition at line 1940 of file OptionParser.h.

◆ rowstart

const char* ROOT::option::PrintUsageImplementation::LinePartIterator::rowstart
private

Ptr to 1st character of current row within rowdesc->help.

Definition at line 1941 of file OptionParser.h.

◆ screenlen

int ROOT::option::PrintUsageImplementation::LinePartIterator::screenlen
private

Length of the current part in screen columns (taking narrow/wide chars into account).

Definition at line 1945 of file OptionParser.h.

◆ tablestart

const Descriptor* ROOT::option::PrintUsageImplementation::LinePartIterator::tablestart
private

The 1st descriptor of the current table.

Definition at line 1939 of file OptionParser.h.

◆ target_line_in_block

int ROOT::option::PrintUsageImplementation::LinePartIterator::target_line_in_block
private

Line index of the parts we should return to the user on this iteration.

Definition at line 1948 of file OptionParser.h.


The documentation for this class was generated from the following file: