1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
//
// 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.
// * Neither the name of NVIDIA CORPORATION nor the names of its
// contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``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.
//
// Copyright (c) 2018 NVIDIA Corporation. All rights reserved.
#ifndef HTML_TABLE_H
#define HTML_TABLE_H
#include "PxSimpleTypes.h"
// only compile this source code under windows!
#if PX_WINDOWS_FAMILY
// A simple code snippet to create an HTML document with multiple tables in it.
//
namespace nvidia
{
enum HtmlSaveType
{
HST_SIMPLE_HTML, // just a very simple HTML document containing the tables.
HST_CSV, // Saves the Tables out as comma seperated value text
HST_TEXT, // Saves the tables out in human readable text format.
HST_TEXT_EXTENDED, // Saves the tables out in human readable text format, but uses the MS-DOS style extended ASCII character set for the borders.
HST_CPP, // Save the document out as C++ code that can re-create it. This is used for debugging the system.
HST_XML, // Save the document into an easily digestable XML format.
};
class HtmlDocument;
class HtmlTableInterface;
class HtmlTable
{
public:
virtual void setColumnColor(unsigned int column,unsigned int color) = 0; // set a color for a specific column.
virtual void setHeaderColor(unsigned int color) = 0; // color for header lines
virtual void setFooterColor(unsigned int color) = 0; // color for footer lines
virtual void setBodyColor(unsigned int color) = 0;
virtual void addHeader(const char *fmt,...) = 0; // Add a column header, each column designtated by CSV. If any single colum has a forward slash, it is treated as a multi-line header.
virtual void addColumn(const char *data) = 0 ; // add this single string to the next column. Also an optional 'color' that will control the background color of this column, starting with the current row.
virtual void addColumn(float v) = 0 ; // will add this floating point number, nicely formatted
virtual void addColumn(int v) = 0; // will add this integer number nicely formatted.
virtual void addColumn(unsigned int v) = 0; // will add this integer number nicely formatted.
virtual void addColumnHex(unsigned int v) = 0; // will add this as a hex string.
virtual void addCSV(bool newRow,const char *fmt,...) = 0; // add this line of data as a set of columns, using the comma character as a seperator.
virtual void nextRow(void) = 0; // advance to the next row.
virtual HtmlDocument *getDocument(void) = 0; // return the parent document.
virtual HtmlTableInterface *getHtmlTableInterface(void) = 0;
virtual void computeTotals(void) = 0; // compute and display totals of numeric columns when displaying this table.
virtual void excludeTotals(unsigned int column) = 0; // Column's are 1 base indexing. Specifies a column to *excude* from totals, even if it contains numeric data.
virtual void addSort(const char *sort_name,unsigned int primary_key,bool primary_ascending,unsigned int secondary_key,bool secondary_ascending) = 0; // adds a sorted result. You can set up mulitple sort requests for a single table.
virtual unsigned int getColor(unsigned int column,bool isHeader,bool isFooter)= 0; // returns color for this column, or header, or footer
virtual void setOrder(unsigned int order) = 0;
};
class HtmlDocument
{
public:
virtual HtmlTable * createHtmlTable(const char *heading) = 0; // create a table and add it to the HTML document.
virtual const char * saveDocument(size_t &len,HtmlSaveType type) =0; // save the document to memory, return a pointer to that memory and the length of the file.
virtual bool saveExcel(const char *fname) = 0; // excel format can only be saved directly to files on disk, as it needs to create a sub-directory for the intermediate files.
virtual void releaseDocumentMemory(const char *mem) = 0; // release memory previously allocated for a document save.
virtual HtmlTableInterface *getHtmlTableInterface(void) = 0;
};
class HtmlTableInterface
{
public:
virtual HtmlDocument * createHtmlDocument(const char *document_name) = 0; // create an HTML document.
virtual void releaseHtmlDocument(HtmlDocument *document) = 0; // release a previously created HTML document
}; // end of namespace
HtmlTableInterface *getHtmlTableInterface(void);
int getHtmlMemoryUsage(void);
};
#endif
#endif
|