MOAB: Mesh Oriented datABase  (version 5.2.1)
ManPage.hpp
Go to the documentation of this file.
00001 /* *****************************************************************
00002     MESQUITE -- The Mesh Quality Improvement Toolkit
00003 
00004     Copyright 2007 Sandia National Laboratories.  Developed at the
00005     University of Wisconsin--Madison under SNL contract number
00006     624796.  The U.S. Government and the University of Wisconsin
00007     retain certain rights to this software.
00008 
00009     This library is free software; you can redistribute it and/or
00010     modify it under the terms of the GNU Lesser General Public
00011     License as published by the Free Software Foundation; either
00012     version 2.1 of the License, or (at your option) any later version.
00013 
00014     This library is distributed in the hope that it will be useful,
00015     but WITHOUT ANY WARRANTY; without even the implied warranty of
00016     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00017     Lesser General Public License for more details.
00018 
00019     You should have received a copy of the GNU Lesser General Public License
00020     (lgpl.txt) along with this library; if not, write to the Free Software
00021     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00022 
00023     (2008) kraftche@cae.wisc.edu
00024 
00025   ***************************************************************** */
00026 
00027 /** \file ManPage.hpp
00028  *  \brief
00029  *  \author Jason Kraftcheck
00030  */
00031 
00032 #ifndef MSQ_MAN_PAGE_HPP
00033 #define MSQ_MAN_PAGE_HPP
00034 
00035 #include "Mesquite.hpp"
00036 #include <iostream>
00037 #include <string>
00038 
00039 class ManPage
00040 {
00041   public:
00042     static std::ostream& begin_bold( std::ostream& str )
00043     {
00044         return str << std::endl << ".B" << std::endl;
00045     }
00046     static std::ostream& end_bold( std::ostream& str )
00047     {
00048         return str << std::endl;
00049     }
00050     static std::ostream& bold( std::ostream& str, const std::string& s )
00051     {
00052         return end_bold( begin_bold( str ) << s );
00053     }
00054 
00055     static std::ostream& begin_italic( std::ostream& str )
00056     {
00057         return str << std::endl << ".I" << std::endl;
00058     }
00059     static std::ostream& end_italic( std::ostream& str )
00060     {
00061         return str << std::endl;
00062     }
00063     static std::ostream& italic( std::ostream& str, const std::string& s )
00064     {
00065         return end_italic( begin_italic( str ) << s );
00066     }
00067 
00068     static std::ostream& begin_section( std::ostream& str, const std::string& name )
00069     {
00070         return str << std::endl << ".SH " << name << std::endl;
00071     }
00072 
00073     static std::ostream& begin_subsection( std::ostream& str, const std::string& name )
00074     {
00075         return str << std::endl << ".SS " << name << std::endl;
00076     }
00077 
00078     static std::ostream& begin_paragraph( std::ostream& str )
00079     {
00080         return str << std::endl << ".P " << std::endl;
00081     }
00082 
00083     static std::ostream& begin_hanging_paragraph( std::ostream& str )
00084     {
00085         return str << std::endl << ".HP " << std::endl;
00086     }
00087 
00088     static std::ostream& begin_indent( std::ostream& str )
00089     {
00090         return str << std::endl << ".RS " << std::endl;
00091     }
00092     static std::ostream& end_indent( std::ostream& str )
00093     {
00094         return str << std::endl << ".RE " << std::endl;
00095     }
00096 
00097     static std::ostream& begin_manpage( std::ostream& str, const std::string& name, int section )
00098     {
00099         return str << std::endl << ".TH " << name << " " << section << std::endl;
00100     }
00101 
00102     static std::ostream& write_text( std::ostream& str, bool hanging_indent, const std::string& text );
00103 };
00104 
00105 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines