Jpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Namespaces | Macros | Enumerations | Functions
JPrint.hh File Reference

I/O formatting auxiliaries. More...

#include <ostream>
#include <sstream>
#include <iomanip>
#include "Jeep/JColor.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  JFlags
 Auxiliary class to temporarily modify format specifications. More...
 

Namespaces

 JEEP
 General puprpose classes and methods.
 
 JPP
 

Macros

#define MAKE_STRING(A)   (static_cast<std::ostringstream&>(JEEP::getOstream() << A)).str()
 Make string. More...
 
#define MAKE_CSTRING(A)   MAKE_STRING(A).c_str()
 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 or 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 MAKE_STRING (   A)    (static_cast<std::ostringstream&>(JEEP::getOstream() << A)).str()

Make string.

Parameters
Astd::ostream compatible construct
Returns
std::string

Definition at line 602 of file JPrint.hh.

#define MAKE_CSTRING (   A)    MAKE_STRING(A).c_str()

Make C-string.

Parameters
Astd::ostream compatible construct
Returns
C-string

Definition at line 611 of file JPrint.hh.

Function Documentation

int getPrintOption ( std::ostream &  out)
inline

Get print option.

Parameters
outoutput stream
Returns
print option

Definition at line 68 of file JPrint.hh.

69 {
70  return out.iword(JEEP::getIndex());
71 }
int getIndex()
Get index for user I/O manipulation.
Definition: JPrint.hh:26
void setPrintOption ( std::ostream &  out,
const int  option 
)
inline

Set print option.

Parameters
outoutput stream
optionprint option

Definition at line 80 of file JPrint.hh.

81 {
82  out.iword(JEEP::getIndex()) = option;
83 }
int getIndex()
Get index for user I/O manipulation.
Definition: JPrint.hh:26
bool getShortprint ( std::ostream &  out)
inline

Get short print option.

Parameters
outoutput stream
Returns
true if short print option is on; else false

Definition at line 92 of file JPrint.hh.

93 {
94  return getPrintOption(out) == JEEP::SHORT_PRINT;
95 }
short print
Definition: JPrint.hh:38
int getPrintOption(std::ostream &out)
Get print option.
Definition: JPrint.hh:68
void setShortprint ( std::ostream &  out)
inline

Set short print option.

Parameters
outoutput stream

Definition at line 103 of file JPrint.hh.

104 {
105  return setPrintOption(out, JEEP::SHORT_PRINT);
106 }
void setPrintOption(std::ostream &out, const int option)
Set print option.
Definition: JPrint.hh:80
short print
Definition: JPrint.hh:38
bool getMediumprint ( std::ostream &  out)
inline

Get medium print option.

Parameters
outoutput stream
Returns
true if medium print option is on; else false

Definition at line 115 of file JPrint.hh.

116 {
117  return getPrintOption(out) == JEEP::MEDIUM_PRINT;
118 }
int getPrintOption(std::ostream &out)
Get print option.
Definition: JPrint.hh:68
medium print
Definition: JPrint.hh:39
void setMediumprint ( std::ostream &  out)
inline

Set medium print option.

Parameters
outoutput stream

Definition at line 126 of file JPrint.hh.

127 {
128  return setPrintOption(out, JEEP::MEDIUM_PRINT);
129 }
void setPrintOption(std::ostream &out, const int option)
Set print option.
Definition: JPrint.hh:80
medium print
Definition: JPrint.hh:39
bool getLongprint ( std::ostream &  out)
inline

Get long print option.

Parameters
outoutput stream
Returns
true if long print option is on; else false

Definition at line 138 of file JPrint.hh.

139 {
140  return getPrintOption(out) == JEEP::LONG_PRINT;
141 }
long print
Definition: JPrint.hh:40
int getPrintOption(std::ostream &out)
Get print option.
Definition: JPrint.hh:68
void setLongprint ( std::ostream &  out)
inline

Set long print option.

Parameters
outoutput stream

Definition at line 149 of file JPrint.hh.

150 {
151  return setPrintOption(out, JEEP::LONG_PRINT);
152 }
long print
Definition: JPrint.hh:40
void setPrintOption(std::ostream &out, const int option)
Set print option.
Definition: JPrint.hh:80
std::ostream& shortprint ( std::ostream &  out)
inline

Set short printing.

Parameters
outoutput stream
Returns
output stream

Definition at line 161 of file JPrint.hh.

162 {
163  setShortprint(out);
164 
165  return out;
166 }
void setShortprint(std::ostream &out)
Set short print option.
Definition: JPrint.hh:103
std::ostream& mediumprint ( std::ostream &  out)
inline

Set medium printing.

Parameters
outoutput stream
Returns
output stream

Definition at line 175 of file JPrint.hh.

176 {
177  setMediumprint(out);
178 
179  return out;
180 }
void setMediumprint(std::ostream &out)
Set medium print option.
Definition: JPrint.hh:126
std::ostream& longprint ( std::ostream &  out)
inline

Set long printing.

Parameters
outoutput stream
Returns
output stream

Definition at line 189 of file JPrint.hh.

190 {
191  setLongprint(out);
192 
193  return out;
194 }
void setLongprint(std::ostream &out)
Set long print option.
Definition: JPrint.hh:149
std::ostream& newline ( std::ostream &  out)
inline

Print newline character.

Parameters
outoutput stream
Returns
output stream

Definition at line 203 of file JPrint.hh.

204 {
205  return out << '\n';
206 }
std::ostream& whitespace ( std::ostream &  out)
inline

Print white space character.

Parameters
outoutput stream
Returns
output stream

Definition at line 215 of file JPrint.hh.

216 {
217  return out << ' ';
218 }
std::ostream& tab ( std::ostream &  out)
inline

Print tab character.

Parameters
outoutput stream
Returns
output stream

Definition at line 227 of file JPrint.hh.

228 {
229  return out << '\t';
230 }
std::ostream& rewind ( std::ostream &  out)
inline

Rewind character.

Parameters
outoutput stream
Returns
output stream

Definition at line 239 of file JPrint.hh.

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