gmPrintUtils.h

Go to the documentation of this file.

/************************************************************************
**
** Copyright (C) 2014 by Carlos Augusto Teixera Mendes
** All rights reserved.
**
** This file is part of the "GeMA" software. It's use should respect
** the terms in the license agreement that can be found together
** with this source code.
** It is provided AS IS, with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE.
**
************************************************************************/
 
#ifndef _GEMA_PRINT_UTILS_H_
#define _GEMA_PRINT_UTILS_H_
 
#include "gmLog.h"
 
class GmValueInfo;
class GmValueAccessor;
class GmCellAccessor;
class GmGaussAccessor;
class GmCellMesh;
class GmElementMesh;
class GmPCR;
 
struct lua_State;
class  LuaTable;
class  Unit;
 
enum GmPrintUtilsFlags
{
  GM_PRINT_UNITS                = 0x000001, 
  GM_PRINT_UNITS_ON_SECOND_LINE = 0x000002, 
  GM_PRINT_EVAL_FUNCTIONS       = 0x000004, 
  GM_PRINT_DEF_AS_NIL           = 0x000008, 
  GM_PRINT_LINE_NUMBERS         = 0x000010, 
  GM_PRINT_CLIP_TITLES          = 0x000020, 
  GM_PRINT_CELL_TYPE            = 0x000040, 
  GM_PRINT_CELL_NODES           = 0x000080, 
  GM_PRINT_CELL_PROPERTY_NAMES  = 0x000100, 
  GM_PRINT_CELL_EVAL_POINT      = 0x000200, 
  GM_PRINT_CELL_ACTIVE          = 0x000400, 
  GM_PRINT_NODE_GEOMETRY        = 0x000800, 
  GM_PRINT_NODE_GHOST           = 0x001000, 
  GM_PRINT_MARK_GHOST_NODES     = 0x002000, 
  GM_PRINT_HEADER_TITLE         = 0x004000, 
  GM_PRINT_TRAILLER             = 0x008000, 
  GM_PRINT_ACTIVEONLY           = 0x010000, 
  GM_PRINT_CONSTMAP             = 0x020000, 
  GM_PRINT_ID                   = 0x040000, 
  GM_PRINT_INTERNAL_ID          = 0x080000, 
  GM_PRINT_INTERNAL_ORDER       = 0x100000, 
 
  // ----- 
  GM_PRINT_USER                 = 0x200000,
 
  // ----- DO not add entries AFTER this line
  GM_PRINT_DEFAULT = GM_PRINT_UNITS | GM_PRINT_LINE_NUMBERS | GM_PRINT_CLIP_TITLES |
                     GM_PRINT_CELL_TYPE | GM_PRINT_CELL_NODES | GM_PRINT_CELL_PROPERTY_NAMES |
                     GM_PRINT_NODE_GEOMETRY | GM_PRINT_NODE_GHOST | GM_PRINT_ACTIVEONLY | 
                     GM_PRINT_ID,
};
 
 
class GMC_API_EXPORT GmPrintUtils
{
public:
  GmPrintUtils(const GmLogCategory& logger, GmLogLevel level = GM_EXT_INFO, int opt = GM_PRINT_DEFAULT)
    : _logger(logger), _level(level), _options(opt), _firstGhostIndex(-1) {}
 
  void setOption(GmPrintUtilsFlags opt, bool mode) { _options = mode ? (_options | opt) : (_options & ~opt); }
 
  void setOptions(int options) { _options = options; }
 
  void setFirstGhostIndex(int index) { _firstGhostIndex = index; }
 
  GmValueAccessor* valueAccessorForStringColumn(QString title, const QStringList& data, int width);
 
  void printValueTable(const QList<GmValueAccessor*>& dataList, QString title = "", const QList<int>& columnWidths = QList<int>(), const GmPCR* pcr = NULL);
  void printCellTable (const GmCellMesh* mesh, const QList<GmCellAccessor* >& dataList, QString title = "", 
                       const QList<int>& columnWidths = QList<int>(), int ip = -1);
  void printGaussTable(const GmElementMesh* mesh, const QList<GmGaussAccessor* >& dataList, QString title = "",
                       const QList<int>& columnWidths = QList<int>());
 
 
  static bool       parseValueIds    (lua_State* L, int index, QString fname, QStringList& valueList, QList<Unit>& unitList);
  static QList<int> parseColumnWidths(lua_State* L, int index, QString fname, int ncol);
  static void       parsePrintOptions(lua_State* L, int index, QString fname, int& options, int* state);
 
  static QString    leftStr  (QString str, int width, bool clip = false);
  static QString    centerStr(QString str, int width, bool clip = false);
  static QString    rightStr (QString str, int width, bool clip = false);
  static QString    quoteStr (QString str, QString separator = ",");
 
  static void       progressBar(int i, int size, int& mark, const GmLogCategory& logger, int freq = 10);
 
protected:
  template <class A> GMC_API_EXPORT void addDataColumnSizes   (const QList<A*>& dataList, const QList<int>& colWidths, QList<int>& sizes);
  template <class A> GMC_API_EXPORT int  printColumnHeaders   (QString title, const QStringList& extraCols, const QList<A*>& dataList, 
                                                               const QList<int>& colWidths);
  template <class A> GMC_API_EXPORT void buildReverseConstMaps(const QList<A*>& dataList, QList<QMap<double, QString> >& revConstMapList);
 
  static void checkOption(LuaTable& table, const char* field, int& options, int flag);
 
  QString center(QString val, int size) { return centerStr(val, size, _options & GM_PRINT_CLIP_TITLES); }
 
  const GmLogCategory& _logger;  
  GmLogLevel           _level;   
  int                  _options; 
  int                  _firstGhostIndex; 
};
 
#endif