JPrint.hh File Reference

I/O formatting auxiliaries. More...

#include <string>
#include <ostream>
#include <sstream>
#include <iomanip>
#include "Jeep/JStreamToolkit.hh"

Go to the source code of this file.

Classes
struct	WIDTH
	Auxiliary data structure for alignment of data. More...
struct	LEFT
	Auxiliary data structure for alignment of data. More...
struct	RIGHT
	Auxiliary data structure for alignment of data. More...
struct	FILL
	Auxiliary data structure for sequence of same character. More...
struct	CENTER
	Auxiliary data structure for alignment of data. More...
struct	CENTER::JCenter
	Auxiliary class for format center. More...
struct	FIXED
	Auxiliary data structure for floating point format specification. More...
struct	SCIENTIFIC
	Auxiliary data structure for floating point format specification. More...
struct	JEEPZ
	Auxiliary data structure for streaming of STL containers. More...
struct	JEEPZ::JStream
	Auxiliary class for format STL containers. More...
struct	JFlags
	Auxiliary class to temporarily modify format specifications. More...

Namespaces
	JEEP
	General puprpose classes and methods.
	JPP
	This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).

Macros
#define	VARGS_STRING(A, B,...)   MAKE_STRING(B)
	Make string for variadic macro. More...
#define	MAKE_STRING(A)   (static_cast<std::ostringstream&>(JEEP::getOstream() << A)).str()
	Make string. More...
#define	MAKE_CSTRING(A)   JEEP::getCString(MAKE_STRING(A))
	Make C-string. More...

Enumerations
enum	JEEP::JPrintOption_t { JEEP::SHORT_PRINT = 1, JEEP::MEDIUM_PRINT = 2, JEEP::LONG_PRINT = 3 }
	Print options. More...

Functions
int	JEEP::getIndex ()
	Get index for user I/O manipulation. More...
std::ostream &	JEEP::getOstream ()
	Get output stream for conversion to std::string. More...
const char *	JEEP::getCString (const std::string &input)
	Get output C-string. More...
int	getPrintOption (std::ostream &out)
	Get print option. More...
void	setPrintOption (std::ostream &out, const int option)
	Set print option. More...
bool	getShortprint (std::ostream &out)
	Get short print option. More...
void	setShortprint (std::ostream &out)
	Set short print option. More...
bool	getMediumprint (std::ostream &out)
	Get medium print option. More...
void	setMediumprint (std::ostream &out)
	Set medium print option. More...
bool	getLongprint (std::ostream &out)
	Get long print option. More...
void	setLongprint (std::ostream &out)
	Set long print option. More...
std::ostream &	shortprint (std::ostream &out)
	Set short printing. More...
std::ostream &	mediumprint (std::ostream &out)
	Set medium printing. More...
std::ostream &	longprint (std::ostream &out)
	Set long printing. More...
std::ostream &	newline (std::ostream &out)
	Print newline character. More...
std::ostream &	whitespace (std::ostream &out)
	Print white space character. More...
std::ostream &	tab (std::ostream &out)
	Print tab character. More...
std::ostream &	rewind (std::ostream &out)
	Rewind character. More...

Detailed Description

I/O formatting auxiliaries.

Author

mdejong

Definition in file JPrint.hh.

Macro Definition Documentation

#define VARGS_STRING	(		A,
			B,
			...
	)		MAKE_STRING(B)

Make string for variadic macro.

When called,

• first argument should correspond to a dummy value;
• second to the ##__VA_ARGS__ macro; and
• third to the fall back value (e.g. "");

Parameters

A	dummy value
B	##__VA_ARGS__ macro

Returns

std::string

Definition at line 690 of file JPrint.hh.

#define MAKE_STRING

(

A

)

(static_cast<std::ostringstream&>(JEEP::getOstream() << A)).str()

Make string.

Parameters

A	std::ostream compatible construct

Returns

std::string

Definition at line 699 of file JPrint.hh.

#define MAKE_CSTRING

(

A

)

JEEP::getCString(MAKE_STRING(A))

Make C-string.

Parameters

A	std::ostream compatible construct

Returns

C-string

Definition at line 708 of file JPrint.hh.

Function Documentation

int getPrintOption ( std::ostream &  out )

inline

Get print option.

Parameters

out	output stream

Returns

print option

Definition at line 87 of file JPrint.hh.

{
  return out.iword(JEEP::getIndex());
}

void setPrintOption ( std::ostream &  out, const int  option  )

inline

Set print option.

Parameters

out	output stream
option	print option

Definition at line 99 of file JPrint.hh.

{
  out.iword(JEEP::getIndex()) = option;
}

bool getShortprint ( std::ostream &  out )

inline

Get short print option.

Parameters

out	output stream

Returns

true if short print option is on; else false

Definition at line 111 of file JPrint.hh.

{
  return getPrintOption(out) == JEEP::SHORT_PRINT;
}

void setShortprint ( std::ostream &  out )

inline

Set short print option.

Parameters

out	output stream

Definition at line 122 of file JPrint.hh.

{
  return setPrintOption(out, JEEP::SHORT_PRINT);
}

bool getMediumprint ( std::ostream &  out )

inline

Get medium print option.

Parameters

out	output stream

Returns

true if medium print option is on; else false

Definition at line 134 of file JPrint.hh.

{
  return getPrintOption(out) == JEEP::MEDIUM_PRINT;
}

void setMediumprint ( std::ostream &  out )

inline

Set medium print option.

Parameters

out	output stream

Definition at line 145 of file JPrint.hh.

{
  return setPrintOption(out, JEEP::MEDIUM_PRINT);
}

bool getLongprint ( std::ostream &  out )

inline

Get long print option.

Parameters

out	output stream

Returns

true if long print option is on; else false

Definition at line 157 of file JPrint.hh.

{
  return getPrintOption(out) == JEEP::LONG_PRINT;
}

void setLongprint ( std::ostream &  out )

inline

Set long print option.

Parameters

out	output stream

Definition at line 168 of file JPrint.hh.

{
  return setPrintOption(out, JEEP::LONG_PRINT);
}

std::ostream& shortprint ( std::ostream &  out )

inline

Set short printing.

Parameters

out	output stream

Returns

output stream

Definition at line 180 of file JPrint.hh.

{
  setShortprint(out);

  return out;
}

std::ostream& mediumprint ( std::ostream &  out )

inline

Set medium printing.

Parameters

out	output stream

Returns

output stream

Definition at line 194 of file JPrint.hh.

{
  setMediumprint(out);

  return out;
}

std::ostream& longprint ( std::ostream &  out )

inline

Set long printing.

Parameters

out	output stream

Returns

output stream

Definition at line 208 of file JPrint.hh.

{
  setLongprint(out);

  return out;
}

std::ostream& newline ( std::ostream &  out )

inline

Print newline character.

Parameters

out	output stream

Returns

output stream

Definition at line 222 of file JPrint.hh.

{
  return out << '\n';
}

std::ostream& whitespace ( std::ostream &  out )

inline

Print white space character.

Parameters

out	output stream

Returns

output stream

Definition at line 234 of file JPrint.hh.

{
  return out << ' ';
}

std::ostream& tab ( std::ostream &  out )

inline

Print tab character.

Parameters

out	output stream

Returns

output stream

Definition at line 246 of file JPrint.hh.

{
  return out << '\t';
}

std::ostream& rewind ( std::ostream &  out )

inline

Rewind character.

Parameters

out	output stream

Returns

output stream

Definition at line 258 of file JPrint.hh.

{
  return (out << '\r').flush();
}