Wireshark  4.3.0
The Wireshark network protocol analyzer
unit_strings.h
Go to the documentation of this file.
1 /* unit_strings.h
2  * Units to append to field values
3  *
4  * Wireshark - Network traffic analyzer
5  * By Gerald Combs <gerald@wireshark.org>
6  * Copyright 1998 Gerald Combs
7  *
8  * SPDX-License-Identifier: GPL-2.0-or-later
9  */
10 
11 #ifndef __UNIT_STRINGS_H__
12 #define __UNIT_STRINGS_H__
13 
14 #include "ws_symbol_export.h"
15 
16 #ifdef __cplusplus
17 extern "C" {
18 #endif /* __cplusplus */
19 
25 typedef struct unit_name_string {
26  char *singular;
27  char *plural;
29 
37 WS_DLL_PUBLIC const char* unit_name_string_get_value(uint32_t value, const unit_name_string* units);
38 
46 WS_DLL_PUBLIC const char* unit_name_string_get_value64(uint64_t value, const unit_name_string* units);
47 
55 WS_DLL_PUBLIC const char* unit_name_string_get_double(double value, const unit_name_string* units);
56 
57 /*
58  * A default set of unit strings that dissectors can use for
59  * header fields.
60  */
61 WS_DLL_PUBLIC const unit_name_string units_foot_feet;
62 WS_DLL_PUBLIC const unit_name_string units_bit_bits;
63 WS_DLL_PUBLIC const unit_name_string units_byte_bytes;
64 WS_DLL_PUBLIC const unit_name_string units_byte_bytespsecond;
65 WS_DLL_PUBLIC const unit_name_string units_octet_octets;
66 WS_DLL_PUBLIC const unit_name_string units_word_words;
67 WS_DLL_PUBLIC const unit_name_string units_tick_ticks;
68 WS_DLL_PUBLIC const unit_name_string units_meters;
69 WS_DLL_PUBLIC const unit_name_string units_meter_meters;
70 WS_DLL_PUBLIC const unit_name_string units_centimeters;
71 WS_DLL_PUBLIC const unit_name_string units_centimeter_centimeters;
72 WS_DLL_PUBLIC const unit_name_string units_millimeters;
73 WS_DLL_PUBLIC const unit_name_string units_millimeter_millimeters;
74 WS_DLL_PUBLIC const unit_name_string units_week_weeks;
75 WS_DLL_PUBLIC const unit_name_string units_day_days;
76 WS_DLL_PUBLIC const unit_name_string units_hour_hours;
77 WS_DLL_PUBLIC const unit_name_string units_hours;
78 WS_DLL_PUBLIC const unit_name_string units_minute_minutes;
79 WS_DLL_PUBLIC const unit_name_string units_minutes;
80 WS_DLL_PUBLIC const unit_name_string units_second_seconds; // full unit name "second[s?]"
81 WS_DLL_PUBLIC const unit_name_string units_seconds; //only seconds abbreviation "s"
82 WS_DLL_PUBLIC const unit_name_string units_millisecond_milliseconds; // full unit name "millisecond[s?]"
83 WS_DLL_PUBLIC const unit_name_string units_milliseconds; //only seconds abbreviation "ms"
84 WS_DLL_PUBLIC const unit_name_string units_microsecond_microseconds; // full unit name "microsecond[s?]"
85 WS_DLL_PUBLIC const unit_name_string units_microseconds; //only seconds abbreviation "us"
86 WS_DLL_PUBLIC const unit_name_string units_nanosecond_nanoseconds; // full unit name "nanosecond[s?]"
87 WS_DLL_PUBLIC const unit_name_string units_nanoseconds; //only seconds abbreviation "ns"
88 WS_DLL_PUBLIC const unit_name_string units_nanometers;
89 WS_DLL_PUBLIC const unit_name_string units_degree_degrees;
90 WS_DLL_PUBLIC const unit_name_string units_degree_celsius;
91 WS_DLL_PUBLIC const unit_name_string units_degree_bearing;
92 WS_DLL_PUBLIC const unit_name_string units_centibels;
93 WS_DLL_PUBLIC const unit_name_string units_decibels;
94 WS_DLL_PUBLIC const unit_name_string units_dbm;
95 WS_DLL_PUBLIC const unit_name_string units_dbi;
96 WS_DLL_PUBLIC const unit_name_string units_dbhz;
97 WS_DLL_PUBLIC const unit_name_string units_mbm;
98 WS_DLL_PUBLIC const unit_name_string units_percent;
99 WS_DLL_PUBLIC const unit_name_string units_khz;
100 WS_DLL_PUBLIC const unit_name_string units_ghz;
101 WS_DLL_PUBLIC const unit_name_string units_mhz;
102 WS_DLL_PUBLIC const unit_name_string units_hz;
103 WS_DLL_PUBLIC const unit_name_string units_hz_s;
104 WS_DLL_PUBLIC const unit_name_string units_kbit;
105 WS_DLL_PUBLIC const unit_name_string units_kbps;
106 WS_DLL_PUBLIC const unit_name_string units_kibps;
107 WS_DLL_PUBLIC const unit_name_string units_pkts;
108 WS_DLL_PUBLIC const unit_name_string units_pkts_per_sec;
109 WS_DLL_PUBLIC const unit_name_string units_km;
110 WS_DLL_PUBLIC const unit_name_string units_kmh;
111 WS_DLL_PUBLIC const unit_name_string units_m_s;
112 WS_DLL_PUBLIC const unit_name_string units_cm_s;
113 WS_DLL_PUBLIC const unit_name_string units_mm_s;
114 WS_DLL_PUBLIC const unit_name_string units_milliamps;
115 WS_DLL_PUBLIC const unit_name_string units_microwatts;
116 WS_DLL_PUBLIC const unit_name_string units_volt;
117 WS_DLL_PUBLIC const unit_name_string units_grams_per_second;
118 WS_DLL_PUBLIC const unit_name_string units_meter_sec;
119 WS_DLL_PUBLIC const unit_name_string units_meter_sec_squared;
120 WS_DLL_PUBLIC const unit_name_string units_bit_sec;
121 WS_DLL_PUBLIC const unit_name_string units_segment_remaining;
122 WS_DLL_PUBLIC const unit_name_string units_frame_frames;
123 WS_DLL_PUBLIC const unit_name_string units_revolutions_per_minute;
124 WS_DLL_PUBLIC const unit_name_string units_kilopascal;
125 WS_DLL_PUBLIC const unit_name_string units_newton_metre;
126 WS_DLL_PUBLIC const unit_name_string units_liter_per_hour;
127 WS_DLL_PUBLIC const unit_name_string units_amp;
128 WS_DLL_PUBLIC const unit_name_string units_watthour;
129 WS_DLL_PUBLIC const unit_name_string units_watt;
130 WS_DLL_PUBLIC const unit_name_string units_bpm;
131 WS_DLL_PUBLIC const unit_name_string units_calorie;
132 WS_DLL_PUBLIC const unit_name_string units_cycle_cycles;
133 
134 #ifdef __cplusplus
135 }
136 #endif /* __cplusplus */
137 
138 #endif /* __UNIT_STRINGS_H__ */
139 
140 /*
141  * Editor modelines
142  *
143  * Local Variables:
144  * c-basic-offset: 4
145  * tab-width: 8
146  * indent-tabs-mode: nil
147  * End:
148  *
149  * ex: set shiftwidth=4 tabstop=8 expandtab:
150  * :indentSize=4:tabSize=8:noTabs=true:
151  */
Definition: unit_strings.h:25
char * singular
Definition: unit_strings.h:26
char * plural
Definition: unit_strings.h:27
struct unit_name_string unit_name_string
WS_DLL_PUBLIC const char * unit_name_string_get_value64(uint64_t value, const unit_name_string *units)
Definition: unit_strings.c:27
WS_DLL_PUBLIC const char * unit_name_string_get_value(uint32_t value, const unit_name_string *units)
Definition: unit_strings.c:18
WS_DLL_PUBLIC const char * unit_name_string_get_double(double value, const unit_name_string *units)
Definition: unit_strings.c:36