blob: cb0540571ba795ad4651648667d836b90419f861 [file] [log] [blame]
Hisham Muhammadd6231ba2006-03-04 18:16:49 +00001#ifndef HEADER_Meter
2#define HEADER_Meter
3/*
Hisham Muhammadf6e0b7d2006-06-06 20:28:42 +00004htop - Meter.h
Hisham Muhammad300caa02011-05-26 16:35:07 +00005(C) 2004-2011 Hisham H. Muhammad
Daniel Lange079c2ab2020-10-05 09:51:32 +02006Released under the GNU GPLv2, see the COPYING file
Hisham Muhammadd6231ba2006-03-04 18:16:49 +00007in the source distribution for its full text.
8*/
9
Christian Göttsche4c66eb62020-10-03 21:20:43 +020010#include "config.h" // IWYU pragma: keep
11
Benny Baumann0f526292020-09-19 13:55:23 +020012#include <stdbool.h>
Christian Göttsche7cf52772020-11-18 14:26:30 +010013#include <stdint.h>
Hisham Muhammad3383d8e2015-01-21 23:27:31 -020014#include <sys/time.h>
Hisham Muhammadd6231ba2006-03-04 18:16:49 +000015
Benny Baumanne1c96872020-09-18 19:23:04 +020016#include "ListItem.h"
Benny Baumann0f526292020-09-19 13:55:23 +020017#include "Object.h"
18#include "ProcessList.h"
19
Benny Baumanne1c96872020-09-18 19:23:04 +020020
Hugo Musso Gualandi92074012020-09-12 18:25:25 -030021#define METER_BUFFER_LEN 256
22
Christian Göttschead764ff2020-11-24 19:34:27 +010023#define METER_BUFFER_CHECK(buffer, size, written) \
24 do { \
25 if ((written) < 0 || (size_t)(written) >= (size)) { \
26 return; \
27 } \
28 (buffer) += (written); \
29 (size) -= (size_t)(written); \
30 } while (0)
31
32#define METER_BUFFER_APPEND_CHR(buffer, size, c) \
33 do { \
34 if ((size) < 2) { \
35 return; \
36 } \
37 *(buffer)++ = c; \
38 *(buffer) = '\0'; \
39 (size)--; \
40 if ((size) == 0) { \
41 return; \
42 } \
43 } while (0)
44
45
Benny Baumann0f526292020-09-19 13:55:23 +020046struct Meter_;
Hisham Muhammadd6231ba2006-03-04 18:16:49 +000047typedef struct Meter_ Meter;
48
Hisham Muhammad00b324b2012-12-05 15:12:20 +000049typedef void(*Meter_Init)(Meter*);
50typedef void(*Meter_Done)(Meter*);
51typedef void(*Meter_UpdateMode)(Meter*, int);
Christian Göttschee1ce1412020-11-24 18:31:03 +010052typedef void(*Meter_UpdateValues)(Meter*, char*, size_t);
Hisham Muhammadd6231ba2006-03-04 18:16:49 +000053typedef void(*Meter_Draw)(Meter*, int, int, int);
54
Hisham Muhammad00b324b2012-12-05 15:12:20 +000055typedef struct MeterClass_ {
Christian Göttsche08d85e62020-10-04 17:55:08 +020056 const ObjectClass super;
Hisham Muhammad00b324b2012-12-05 15:12:20 +000057 const Meter_Init init;
58 const Meter_Done done;
59 const Meter_UpdateMode updateMode;
60 const Meter_Draw draw;
Explorer099dea20e2016-05-04 13:39:26 +080061 const Meter_UpdateValues updateValues;
Hisham Muhammad00b324b2012-12-05 15:12:20 +000062 const int defaultMode;
Hisham Muhammad00b324b2012-12-05 15:12:20 +000063 const double total;
Christian Göttsche08d85e62020-10-04 17:55:08 +020064 const int* const attributes;
Christian Göttsche472f0122020-11-29 15:26:57 +010065 const char* const name; /* internal name of the meter, must not contain any space */
66 const char* const uiName; /* display name in header setup menu */
67 const char* const caption; /* prefix in the actual header */
68 const char* const description; /* optional meter description in header setup menu */
Christian Göttsche43d274a2020-10-29 23:17:12 +010069 const uint8_t maxItems;
Hisham Muhammad00b324b2012-12-05 15:12:20 +000070} MeterClass;
71
Christian Göttsche08d85e62020-10-04 17:55:08 +020072#define As_Meter(this_) ((const MeterClass*)((this_)->super.klass))
Hisham Muhammad00b324b2012-12-05 15:12:20 +000073#define Meter_initFn(this_) As_Meter(this_)->init
74#define Meter_init(this_) As_Meter(this_)->init((Meter*)(this_))
75#define Meter_done(this_) As_Meter(this_)->done((Meter*)(this_))
76#define Meter_updateModeFn(this_) As_Meter(this_)->updateMode
77#define Meter_updateMode(this_, m_) As_Meter(this_)->updateMode((Meter*)(this_), m_)
78#define Meter_drawFn(this_) As_Meter(this_)->draw
79#define Meter_doneFn(this_) As_Meter(this_)->done
Explorer099dea20e2016-05-04 13:39:26 +080080#define Meter_updateValues(this_, buf_, sz_) \
81 As_Meter(this_)->updateValues((Meter*)(this_), buf_, sz_)
Hisham Muhammad00b324b2012-12-05 15:12:20 +000082#define Meter_defaultMode(this_) As_Meter(this_)->defaultMode
Hisham Muhammad00b324b2012-12-05 15:12:20 +000083#define Meter_attributes(this_) As_Meter(this_)->attributes
84#define Meter_name(this_) As_Meter(this_)->name
85#define Meter_uiName(this_) As_Meter(this_)->uiName
Hisham Muhammadd6231ba2006-03-04 18:16:49 +000086
Christian Göttsche0b9a0012020-10-02 16:27:57 +020087typedef struct GraphData_ {
88 struct timeval time;
89 double values[METER_BUFFER_LEN];
90} GraphData;
91
Hisham Muhammadd6231ba2006-03-04 18:16:49 +000092struct Meter_ {
93 Object super;
Hisham Muhammad00b324b2012-12-05 15:12:20 +000094 Meter_Draw draw;
Daniel Flanagandd334442019-10-31 11:39:12 -050095
Hisham Muhammad33113fe2006-04-10 20:40:38 +000096 char* caption;
Hisham Muhammad33113fe2006-04-10 20:40:38 +000097 int mode;
98 int param;
Christian Göttsche0b9a0012020-10-02 16:27:57 +020099 GraphData* drawData;
Hisham Muhammad33113fe2006-04-10 20:40:38 +0000100 int h;
Christian Göttsche72103e92020-10-21 21:25:50 +0200101 const ProcessList* pl;
Christian Göttsche43d274a2020-10-29 23:17:12 +0100102 uint8_t curItems;
Hisham Muhammadd6231ba2006-03-04 18:16:49 +0000103 double* values;
104 double total;
Christian Göttsche9f5b50e2020-09-23 11:58:11 +0200105 void* meterData;
Hisham Muhammadd6231ba2006-03-04 18:16:49 +0000106};
107
Hisham Muhammad00b324b2012-12-05 15:12:20 +0000108typedef struct MeterMode_ {
109 Meter_Draw draw;
110 const char* uiName;
111 int h;
112} MeterMode;
Hisham Muhammada9c0ea32011-03-22 20:37:08 +0000113
Hisham Muhammad33113fe2006-04-10 20:40:38 +0000114typedef enum {
115 CUSTOM_METERMODE = 0,
116 BAR_METERMODE,
117 TEXT_METERMODE,
Hisham Muhammad33113fe2006-04-10 20:40:38 +0000118 GRAPH_METERMODE,
119 LED_METERMODE,
Hisham Muhammad33113fe2006-04-10 20:40:38 +0000120 LAST_METERMODE
121} MeterModeId;
122
Christian Göttscheba282cf2020-10-05 13:19:50 +0200123extern const MeterClass Meter_class;
Hisham Muhammadd6231ba2006-03-04 18:16:49 +0000124
Christian Göttsche72103e92020-10-21 21:25:50 +0200125Meter* Meter_new(const ProcessList* pl, int param, const MeterClass* type);
Hisham Muhammadd6231ba2006-03-04 18:16:49 +0000126
Christian Göttschee1ce1412020-11-24 18:31:03 +0100127int Meter_humanUnit(char* buffer, unsigned long int value, size_t size);
Christian Hesse6f58fbc2015-06-12 09:50:55 +0200128
Zev Weiss7b7822b2020-09-02 02:38:44 -0500129void Meter_delete(Object* cast);
Hisham Muhammadd6231ba2006-03-04 18:16:49 +0000130
Zev Weiss7b7822b2020-09-02 02:38:44 -0500131void Meter_setCaption(Meter* this, const char* caption);
Hisham Muhammadd6231ba2006-03-04 18:16:49 +0000132
Zev Weiss7b7822b2020-09-02 02:38:44 -0500133void Meter_setMode(Meter* this, int modeIndex);
Hisham Muhammadd6231ba2006-03-04 18:16:49 +0000134
Zev Weiss7b7822b2020-09-02 02:38:44 -0500135ListItem* Meter_toListItem(Meter* this, bool moving);
Hisham Muhammadd6231ba2006-03-04 18:16:49 +0000136
Christian Göttscheba282cf2020-10-05 13:19:50 +0200137extern const MeterMode* const Meter_modes[];
Hisham Muhammadda23c8c2008-03-09 08:58:38 +0000138
Christian Göttscheba282cf2020-10-05 13:19:50 +0200139extern const MeterClass BlankMeter_class;
Hisham Muhammad6d90e582014-02-27 16:35:22 -0300140
Hisham Muhammadd6231ba2006-03-04 18:16:49 +0000141#endif