Figlet.hh

Go to the documentation of this file.

/*--------------------------------------------------------------------------*\
 |         , __                 , __                                        |
 |        /|/  \               /|/  \                                       |
 |         | __/ _   ,_         | __/ _   ,_                                | 
 |         |   \|/  /  |  |   | |   \|/  /  |  |   |                        |
 |         |(__/|__/   |_/ \_/|/|(__/|__/   |_/ \_/|/                       |
 |                           /|                   /|                        |
 |                           \|                   \|                        |
 |                                                                          |
 |      Enrico Bertolazzi                                                   |
 |      Dipartimento di Ingegneria Industriale                              |
 |      Università degli Studi di Trento                                    |
 |      email: enrico.bertolazzi@unitn.it                                   |
 |                                                                          |
\*--------------------------------------------------------------------------*/
/*
Copyright (c) 2014, Enrico Bertolazzi
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
 
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in
      the documentation and/or other materials provided with the distribution
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
 
//
// file: Figlet.hh
//
 
// check for bugged compiler
#ifdef _MSC_VER
  #define EMBED_FIGLET_USE_VISUAL_STUDIO
#endif
 
// http://ruletheweb.co.uk/figlet/



 
#ifndef FIGLET_HH
#define FIGLET_HH
 
#include <iostream>
#include <cstdint>

namespace Figlet {
 
  using namespace std;
 
  typedef std::basic_ostream<char> ostream_type;
 
  static unsigned const maxHeight    = 10;  
  static unsigned const maxLenght    = 256; 
  static unsigned const maxTableSize = 256; 

  typedef struct {
    unsigned short nchar;              
    uint8_t        lspaces[maxHeight]; 
    uint8_t        rspaces[maxHeight]; 
    char const *   rows[maxHeight];    
  } FontFiglet;

  typedef enum {
    FIGLET_SMUSHED=0,
    FIGLET_PACKED,
    FIGLET_FULLWIDTH,
    FIGLET_MONOSPACED
  } PrintMode;

  typedef enum { FIGLET_SINGLE=0, FIGLET_DOUBLE } FrameMode;

  class Banner {
 
    FontFiglet const * characters; 
    char       const   Hardblank;  
    unsigned   const   Height;     
    unsigned           Width;      
    unsigned   const   FontMaxLen; 
    unsigned   const   FontSize;   
    uint8_t            rspaces[maxHeight]; 
    char               lines[maxHeight][maxLenght]; 
    char               smush[maxHeight];            
    unsigned short     charToTable[maxTableSize];   
    unsigned short     charWidth[maxTableSize];     
    unsigned           charPosition;                
 
    PrintMode          printMode; 
 
    Banner const & operator = ( Banner const & );
    Banner( Banner const & );

    char smushingRules( char left, char right ) const;
 
    bool pushMonospaced( unsigned c );
    bool pushFullWidth( unsigned c );
    bool pushPacked( unsigned c );
    bool pushSmushed( unsigned c );
    void fillForPrint( char const message[] );
 
  public:


    explicit
    Banner( FontFiglet const * characters,
            char               Hardblank,
            unsigned           Height,
            unsigned           FontMaxLen,
            unsigned           FontSize );

    void init();

    void setMonospaced() { printMode = FIGLET_MONOSPACED; }

    void setFullWidth() { printMode = FIGLET_FULLWIDTH; }

    void setPacked() { printMode = FIGLET_PACKED; }

    void setSmushed() { printMode = FIGLET_SMUSHED; }

    unsigned
    print(
      char const     message[],
      ostream_type & s        = cout,
      char const     top[]    = "",
      char const     bottom[] = ""
    );

    void
    printFramed(
      char const     message[],
      ostream_type & s  = cout,
      FrameMode      fm = FIGLET_SINGLE
    );
  };
 
  #ifdef big
    #undef big
  #endif
  #ifdef banner
    #undef banner
  #endif
  #ifdef doom
    #undef doom
  #endif
  #ifdef larry3d
    #undef larry3d
  #endif
  #ifdef mini
    #undef mini
  #endif
  #ifdef script
    #undef script
  #endif
  #ifdef small
    #undef small
  #endif
  #ifdef standard
    #undef standard
  #endif
  #ifdef straight
    #undef straights
  #endif
 
  extern Banner big;      
  extern Banner banner;   
  extern Banner doom;     
  extern Banner larry3d;  
  extern Banner mini;     
  extern Banner script;   
  extern Banner small;    
  extern Banner standard; 
  extern Banner straight; 
 
}
 
#endif
 
//
// eof: Figlet.hh
//