cosmetic changes: APC UPS driver now sets model name as device name
[public/netxms.git] / include / nms_util.h
CommitLineData
e9246d26 1/*
7ac71e60 2** NetXMS - Network Management System
36e44abe 3** Copyright (C) 2003-2011 Victor Kirhenshtein
e9246d26
VK
4**
5** This program is free software; you can redistribute it and/or modify
68f384ea
VK
6** it under the terms of the GNU Lesser General Public License as published
7** by the Free Software Foundation; either version 3 of the License, or
e9246d26
VK
8** (at your option) any later version.
9**
10** This program is distributed in the hope that it will be useful,
11** but WITHOUT ANY WARRANTY; without even the implied warranty of
12** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13** GNU General Public License for more details.
14**
68f384ea 15** You should have received a copy of the GNU Lesser General Public License
e9246d26
VK
16** along with this program; if not, write to the Free Software
17** Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18**
fb7ce4b9 19** File: nms_util.h
e9246d26
VK
20**
21**/
22
23#ifndef _nms_util_h_
24#define _nms_util_h_
25
64584976
VK
26#ifdef _WIN32
27#ifdef LIBNETXMS_EXPORTS
28#define LIBNETXMS_EXPORTABLE __declspec(dllexport)
29#else
30#define LIBNETXMS_EXPORTABLE __declspec(dllimport)
31#endif
32#else /* _WIN32 */
33#define LIBNETXMS_EXPORTABLE
34#endif
35
36
e9246d26
VK
37#include <nms_common.h>
38#include <nms_cscp.h>
953dfe76 39#include <nms_threads.h>
64584976 40#include <time.h>
e9246d26 41
6d8aee95
VK
42#if HAVE_BYTESWAP_H
43#include <byteswap.h>
44#endif
45
92502d5f
VK
46#include <base64.h>
47
6d8aee95
VK
48
49//
92502d5f 50// Serial communications
6d8aee95
VK
51//
52
53#ifdef _WIN32
54
55#define FLOW_NONE 0
56#define FLOW_SOFTWARE 1
57#define FLOW_HARDWARE 2
58
59#else /* _WIN32 */
60
70fed300
AK
61#ifdef HAVE_TERMIOS_H
62# include <termios.h>
63#else
64# error termios.h not found
65#endif
66
6d8aee95
VK
67#endif /* _WIN32 */
68
69
70//
66c04cc7
VK
71// Return codes for IcmpPing()
72//
73
74#define ICMP_SUCCESS 0
75#define ICMP_UNREACHEABLE 1
76#define ICMP_TIMEOUT 2
77#define ICMP_RAW_SOCK_FAILED 3
78
79
80//
4826c8a5 81// Token types for configuration loader
dcb44c9a
VK
82//
83
4826c8a5
VK
84#define CT_LONG 0
85#define CT_STRING 1
86#define CT_STRING_LIST 2
87#define CT_END_OF_LIST 3
88#define CT_BOOLEAN 4
89#define CT_WORD 5
fc935a60 90#define CT_IGNORE 6
4826c8a5
VK
91
92
93//
94// Return codes for NxLoadConfig()
95//
96
97#define NXCFG_ERR_OK 0
98#define NXCFG_ERR_NOFILE 1
99#define NXCFG_ERR_SYNTAX 2
100
101
102//
9f2902ac
VK
103// nxlog_open() flags
104//
105
106#define NXLOG_USE_SYSLOG ((DWORD)0x00000001)
107#define NXLOG_PRINT_TO_STDOUT ((DWORD)0x00000002)
108#define NXLOG_IS_OPEN ((DWORD)0x80000000)
109
110
111//
35f836fe 112// _tcsdup() replacement
8ff13508
VK
113//
114
115#if defined(_WIN32) && defined(USE_WIN32_HEAP)
116#ifdef __cplusplus
117extern "C" {
118#endif
35f836fe 119char LIBNETXMS_EXPORTABLE *nx__tcsdup(const char *src);
8ff13508
VK
120WCHAR LIBNETXMS_EXPORTABLE *nx_wcsdup(const WCHAR *src);
121#ifdef __cplusplus
122}
123#endif
124#endif
125
126
127//
b160350d
VK
128// Class for serial communications
129//
130
131#ifdef __cplusplus
132
133#ifndef _WIN32
134enum
135{
136 NOPARITY,
137 ODDPARITY,
138 EVENPARITY,
139 ONESTOPBIT,
140 TWOSTOPBITS
141};
142
70fed300
AK
143enum
144{
145 FLOW_NONE,
146 FLOW_HARDWARE,
147 FLOW_SOFTWARE
148};
149
b160350d
VK
150#ifndef INVALID_HANDLE_VALUE
151#define INVALID_HANDLE_VALUE (-1)
152#endif
153#endif /* _WIN32 */
154
155class LIBNETXMS_EXPORTABLE Serial
156{
157public:
158 Serial(void);
159 ~Serial(void);
160
e2d68ddd 161 bool Open(const TCHAR *pszPort);
b160350d
VK
162 void Close(void);
163 void SetTimeout(int nTimeout);
f3a581d0
AK
164 int Read(char *pBuff, int nSize); /* waits up to timeout and do single read */
165 int ReadAll(char *pBuff, int nSize); /* read until timeout or out of space */
e2d68ddd 166 bool Write(const char *pBuff, int nSize);
b160350d
VK
167 void Flush(void);
168 bool Set(int nSpeed, int nDataBits, int nParity, int nStopBits);
70fed300 169 bool Set(int nSpeed, int nDataBits, int nParity, int nStopBits, int nFlowControl);
b160350d
VK
170 bool Restart(void);
171
172private:
173 TCHAR *m_pszPort;
174 int m_nTimeout;
175 int m_nSpeed;
176 int m_nDataBits;
177 int m_nStopBits;
178 int m_nParity;
70fed300 179 int m_nFlowControl;
b160350d
VK
180
181#ifndef _WIN32
182 int m_hPort;
70fed300 183 struct termios m_originalSettings;
b160350d
VK
184#else
185 HANDLE m_hPort;
186#endif
187};
188
ff214673
VK
189
190//
191// Class for table data storage
192//
193
ccc34207
VK
194class CSCPMessage;
195
ff214673
VK
196class LIBNETXMS_EXPORTABLE Table
197{
198private:
199 int m_nNumRows;
200 int m_nNumCols;
201 TCHAR **m_ppData;
202 TCHAR **m_ppColNames;
e31c8e60
VK
203 LONG *m_colFormats;
204 TCHAR *m_title;
ff214673
VK
205
206public:
207 Table();
ccc34207 208 Table(CSCPMessage *msg);
ff214673
VK
209 ~Table();
210
3d5610eb 211 int fillMessage(CSCPMessage &msg, int offset, int rowLimit);
9e126e57 212
e31c8e60
VK
213 int getNumRows() { return m_nNumRows; }
214 int getNumColumns() { return m_nNumCols; }
215 const TCHAR *getTitle() { return CHECK_NULL_EX(m_title); }
9e126e57 216
e31c8e60
VK
217 const TCHAR *getColumnName(int col) { return ((col >= 0) && (col < m_nNumCols)) ? m_ppColNames[col] : NULL; }
218 LONG getColumnFormat(int col) { return ((col >= 0) && (col < m_nNumCols)) ? m_colFormats[col] : 0; }
219
220 void setTitle(const TCHAR *title) { safe_free(m_title); m_title = (title != NULL) ? _tcsdup(title) : NULL; }
221 int addColumn(const TCHAR *name, LONG format = 0);
222 int addRow();
9e126e57
VK
223
224 void setAt(int nRow, int nCol, LONG nData);
225 void setAt(int nRow, int nCol, DWORD dwData);
226 void setAt(int nRow, int nCol, double dData);
227 void setAt(int nRow, int nCol, INT64 nData);
228 void setAt(int nRow, int nCol, QWORD qwData);
229 void setAt(int nRow, int nCol, const TCHAR *pszData);
230 void setPreallocatedAt(int nRow, int nCol, TCHAR *pszData);
231
232 void set(int nCol, LONG nData) { setAt(m_nNumRows - 1, nCol, nData); }
233 void set(int nCol, DWORD dwData) { setAt(m_nNumRows - 1, nCol, dwData); }
234 void set(int nCol, double dData) { setAt(m_nNumRows - 1, nCol, dData); }
235 void set(int nCol, INT64 nData) { setAt(m_nNumRows - 1, nCol, nData); }
236 void set(int nCol, QWORD qwData) { setAt(m_nNumRows - 1, nCol, qwData); }
237 void set(int nCol, const TCHAR *pszData) { setAt(m_nNumRows - 1, nCol, pszData); }
238 void setPreallocated(int nCol, TCHAR *pszData) { setPreallocatedAt(m_nNumRows - 1, nCol, pszData); }
239
240 const TCHAR *getAsString(int nRow, int nCol);
241 LONG getAsInt(int nRow, int nCol);
242 DWORD getAsUInt(int nRow, int nCol);
243 INT64 getAsInt64(int nRow, int nCol);
244 QWORD getAsUInt64(int nRow, int nCol);
245 double getAsDouble(int nRow, int nCol);
ff214673
VK
246};
247
8bad8476
VK
248
249//
250// Dynamic string class
251//
252
253class LIBNETXMS_EXPORTABLE String
254{
255protected:
256 TCHAR *m_pszBuffer;
257 DWORD m_dwBufSize;
258
259public:
c577e360
VK
260 static const int npos;
261
8bad8476 262 String();
f3cdd1c5 263 String(const TCHAR *init);
643c9dcb 264 String(const String &src);
8bad8476
VK
265 ~String();
266
ce7565e7 267 void setBuffer(TCHAR *pszBuffer);
8bad8476 268
2391d4fd 269 const String& operator =(const TCHAR *pszStr);
49bf9d8d 270 const String& operator =(const String &src);
2391d4fd 271 const String& operator +=(const TCHAR *pszStr);
ce7565e7 272 operator const TCHAR*() { return CHECK_NULL_EX(m_pszBuffer); }
8bad8476 273
08b214c6
VK
274 char *getUTF8String();
275
ce7565e7
VK
276 void addString(const TCHAR *pStr, DWORD dwLen);
277 void addDynamicString(TCHAR *pszStr) { if (pszStr != NULL) { *this += pszStr; free(pszStr); } }
c577e360 278
ce7565e7
VK
279 void addMultiByteString(const char *pStr, DWORD dwSize, int nCodePage);
280 void addWideCharString(const WCHAR *pStr, DWORD dwSize);
ff175e91 281
ce7565e7 282 void addFormattedString(const TCHAR *format, ...);
893dfdd7 283 void addFormattedStringV(const TCHAR *format, va_list args);
ce7565e7
VK
284 void escapeCharacter(int ch, int esc);
285 void translate(const TCHAR *pszSrc, const TCHAR *pszDst);
c577e360 286
ce7565e7
VK
287 DWORD getSize() { return m_dwBufSize > 0 ? m_dwBufSize - 1 : 0; }
288 BOOL isEmpty() { return m_dwBufSize <= 1; }
c577e360 289
ce7565e7
VK
290 TCHAR *subStr(int nStart, int nLen, TCHAR *pszBuffer);
291 TCHAR *subStr(int nStart, int nLen) { return subStr(nStart, nLen, NULL); }
292 int find(const TCHAR *pszStr, int nStart = 0);
1e1450ef 293
0bbab9d3
VK
294 void trim();
295 void shrink(int chars = 1);
c577e360
VK
296};
297
298
299//
300// String map class
301//
302
303class LIBNETXMS_EXPORTABLE StringMap
304{
305protected:
fb986055
VK
306 DWORD m_size;
307 TCHAR **m_keys;
308 TCHAR **m_values;
c577e360 309
fb986055 310 DWORD find(const TCHAR *key);
c577e360
VK
311
312public:
313 StringMap();
fb986055 314 StringMap(const StringMap &src);
c577e360
VK
315 ~StringMap();
316
fb986055 317 StringMap& operator =(const StringMap &src);
40b7416c 318
fb986055
VK
319 void set(const TCHAR *key, const TCHAR *value);
320 void setPreallocated(TCHAR *key, TCHAR *value);
5ad2167d
VK
321 void set(const TCHAR *key, DWORD value);
322
fb986055 323 const TCHAR *get(const TCHAR *key);
5ad2167d
VK
324 DWORD getULong(const TCHAR *key, DWORD defaultValue);
325
fb986055
VK
326 void remove(const TCHAR *key);
327 void clear();
c577e360 328
fb986055
VK
329 DWORD getSize() { return m_size; }
330 const TCHAR *getKeyByIndex(DWORD idx) { return (idx < m_size) ? CHECK_NULL_EX(m_keys[idx]) : NULL; }
331 const TCHAR *getValueByIndex(DWORD idx) { return (idx < m_size) ? CHECK_NULL_EX(m_values[idx]) : NULL; }
8bad8476
VK
332};
333
6173bea8
VK
334
335//
336// String list class
337//
338
339class LIBNETXMS_EXPORTABLE StringList
340{
341private:
342 int m_count;
343 int m_allocated;
344 TCHAR **m_values;
345
346public:
347 StringList();
348 ~StringList();
349
350 void add(const TCHAR *value);
351 void addPreallocated(TCHAR *value);
352 void add(LONG value);
353 void add(DWORD value);
354 void add(INT64 value);
355 void add(QWORD value);
356 void add(double value);
357 void clear();
358 int getSize() { return m_count; }
359 const TCHAR *getValue(int index) { return ((index >=0) && (index < m_count)) ? m_values[index] : NULL; }
360};
361
0d75ea88
VK
362
363//
364// Dynamic array class
365//
366
367class LIBNETXMS_EXPORTABLE Array
368{
369private:
370 int m_size;
371 int m_allocated;
372 int m_grow;
373 void **m_data;
374 bool m_objectOwner;
375
376protected:
377 virtual void destroyObject(void *object);
378
379public:
380 Array(int initial = 0, int grow = 16, bool owner = false);
381 virtual ~Array();
382
383 int add(void *object);
384 void *get(int index) { return ((index >= 0) && (index < m_size)) ? m_data[index] : NULL; }
385 void remove(int index);
386 void clear();
387
388 int size() { return m_size; }
389
390 void setOwner(bool owner) { m_objectOwner = owner; }
391 bool isOwner() { return m_objectOwner; }
392};
393
394template <class T> class ObjectArray : public Array
395{
396protected:
397 virtual void destroyObject(void *object) { delete (T*)object; }
398
399public:
926e8ce7 400 ObjectArray(int initial = 0, int grow = 16, bool owner = false) : Array(initial, grow, owner) { }
0d75ea88
VK
401 virtual ~ObjectArray() { }
402
403 int add(T *object) { return Array::add(object); }
404 T *get(int index) { return (T*)Array::get(index); }
405};
406
7f632dfe
VK
407
408//
409// Auxilliary class for objects which counts references and
410// destroys itself wheren reference count falls to 0
411//
412
413class LIBNETXMS_EXPORTABLE RefCountObject
414{
415private:
416 int m_refCount;
417 MUTEX m_mutex;
418
419public:
420 RefCountObject();
421 virtual ~RefCountObject();
422
423 void incRefCount();
424 void decRefCount();
425};
426
b160350d
VK
427#endif /* __cplusplus */
428
429
430//
4826c8a5
VK
431// Configuration item template for configuration loader
432//
433
434typedef struct
435{
018fda4d 436 TCHAR szToken[64];
4826c8a5
VK
437 BYTE iType;
438 BYTE cSeparator; // Separator character for lists
439 WORD wListElements; // Number of list elements, should be set to 0 before calling NxLoadConfig()
440 DWORD dwBufferSize; // Buffer size for strings or flag to be set for CT_BOOLEAN
441 DWORD dwBufferPos; // Should be set to 0
442 void *pBuffer;
443} NX_CFG_TEMPLATE;
dcb44c9a
VK
444
445
446//
bc858635
VK
447// Code translation structure
448//
449
450typedef struct __CODE_TO_TEXT
451{
452 int code;
453 const TCHAR *text;
454} CODE_TO_TEXT;
455
456
457//
3046f9a4
VK
458// getopt() prototype if needed
459//
460
461#ifdef _WIN32
99e50bb7 462#include <netxms_getopt.h>
3046f9a4
VK
463#endif
464
465
466//
f2fdf1b5
VK
467// Win32 API functions missing under WinCE
468//
469
c32b805a 470#if defined(UNDER_CE) && defined(__cplusplus)
f2fdf1b5
VK
471
472inline void GetSystemTimeAsFileTime(LPFILETIME pFt)
473{
474 SYSTEMTIME sysTime;
475
476 GetSystemTime(&sysTime);
477 SystemTimeToFileTime(&sysTime, pFt);
478}
479
480#endif // UNDER_CE
481
482
483//
3d1cb7d6
VK
484// Structures for opendir() / readdir() / closedir()
485//
486
487#ifdef _WIN32
488
7f9e0c00 489typedef struct dirent
3d1cb7d6
VK
490{
491 long d_ino; /* inode number (not used by MS-DOS) */
492 int d_namlen; /* Name length */
493 char d_name[257]; /* file name */
494} _DIRECT;
495
496typedef struct _dir_struc
497{
498 char *start; /* Starting position */
499 char *curr; /* Current position */
500 long size; /* Size of string table */
501 long nfiles; /* number if filenames in table */
7f9e0c00 502 struct dirent dirstr; /* Directory structure to return */
3d1cb7d6
VK
503} DIR;
504
5ea2db30
VK
505#ifdef UNICODE
506
507typedef struct dirent_w
508{
509 long d_ino; /* inode number (not used by MS-DOS) */
510 int d_namlen; /* Name length */
511 WCHAR d_name[257]; /* file name */
512} _DIRECTW;
513
514typedef struct _dir_struc_w
515{
516 WCHAR *start; /* Starting position */
517 WCHAR *curr; /* Current position */
518 long size; /* Size of string table */
519 long nfiles; /* number if filenames in table */
520 struct dirent_w dirstr; /* Directory structure to return */
521} DIRW;
522
523#define _TDIR DIRW
524#define _TDIRECT _DIRECTW
525#define _tdirent dirent_w
526
527#else
528
529#define _TDIR DIR
530#define _TDIRECT _DIRECT
531#define _tdirent dirent
532
37d62364
AK
533#endif
534
3d1cb7d6
VK
535#endif /* _WIN32 */
536
537
538//
e9246d26
VK
539// Functions
540//
541
43d92b4c 542
babb8280 543#if WORDS_BIGENDIAN
43d92b4c
VK
544#define htonq(x) (x)
545#define ntohq(x) (x)
9f20696e
VK
546#define htond(x) (x)
547#define ntohd(x) (x)
babb8280
VK
548#define SwapWideString(x)
549#else
ca6ad6bb
VK
550#ifdef HAVE_HTONLL
551#define htonq(x) htonll(x)
552#else
babb8280 553#define htonq(x) __bswap_64(x)
ca6ad6bb
VK
554#endif
555#ifdef HAVE_NTOHLL
556#define ntohq(x) ntohll(x)
557#else
babb8280 558#define ntohq(x) __bswap_64(x)
ca6ad6bb 559#endif
babb8280
VK
560#define htond(x) __bswap_double(x)
561#define ntohd(x) __bswap_double(x)
562#define SwapWideString(x) __bswap_wstr(x)
43d92b4c 563#endif
15929b31 564
55b33d4c
VK
565#ifdef UNDER_CE
566#define close(x) CloseHandle((HANDLE)(x))
567#endif
568
b50f1100 569#ifdef __cplusplus
c81979bc 570#ifndef LIBNETXMS_INLINE
4299401e 571 inline TCHAR *nx_strncpy(TCHAR *pszDest, const TCHAR *pszSrc, size_t nLen)
c81979bc 572 {
912b994d
VK
573#if defined(_WIN32) && (_MSC_VER >= 1400)
574 _tcsncpy_s(pszDest, nLen, pszSrc, _TRUNCATE);
575#else
c81979bc
VK
576 _tcsncpy(pszDest, pszSrc, nLen - 1);
577 pszDest[nLen - 1] = 0;
912b994d 578#endif
c81979bc
VK
579 return pszDest;
580 }
581#endif
582#else
7b8b337e
VK
583TCHAR LIBNETXMS_EXPORTABLE *nx_strncpy(TCHAR *pszDest, const TCHAR *pszSrc, size_t nLen);
584#endif
585
586#ifdef __cplusplus
587int LIBNETXMS_EXPORTABLE ConnectEx(SOCKET s, struct sockaddr *addr, int len, DWORD timeout);
588int LIBNETXMS_EXPORTABLE SendEx(SOCKET, const void *, size_t, int, MUTEX);
589int LIBNETXMS_EXPORTABLE RecvEx(SOCKET nSocket, const void *pBuff,
590 size_t nSize, int nFlags, DWORD dwTimeout);
c81979bc
VK
591#endif
592
593#ifdef __cplusplus
e9246d26
VK
594extern "C"
595{
b50f1100 596#endif
c5b523e2
VK
597#if defined(_WIN32) || !(HAVE_DECL___BSWAP_32)
598 DWORD LIBNETXMS_EXPORTABLE __bswap_32(DWORD dwVal);
599#endif
f52be742 600#if defined(_WIN32) || !(HAVE_DECL___BSWAP_64)
64584976
VK
601 QWORD LIBNETXMS_EXPORTABLE __bswap_64(QWORD qwVal);
602#endif
9f20696e 603 double LIBNETXMS_EXPORTABLE __bswap_double(double dVal);
273da39a 604 void LIBNETXMS_EXPORTABLE __bswap_wstr(UCS2CHAR *pStr);
64584976 605
076a55c4 606#if !defined(_WIN32) && !defined(_NETWARE)
8b86c5dc
VK
607#if defined(UNICODE_UCS2) || defined(UNICODE_UCS4)
608 void LIBNETXMS_EXPORTABLE wcsupr(WCHAR *in);
609#endif
610 void LIBNETXMS_EXPORTABLE strupr(char *in);
7e679c4b 611#endif
ab588c84 612
b8a8d064
VK
613 void LIBNETXMS_EXPORTABLE QSortEx(void *base, size_t nmemb, size_t size, void *arg,
614 int (*compare)(const void *, const void *, void *));
615
670c7f3d 616 INT64 LIBNETXMS_EXPORTABLE GetCurrentTimeMs(void);
3aa0061c 617 QWORD LIBNETXMS_EXPORTABLE FileSize(const TCHAR *pszFileName);
670c7f3d 618
64584976 619 int LIBNETXMS_EXPORTABLE BitsInMask(DWORD dwMask);
018fda4d 620 TCHAR LIBNETXMS_EXPORTABLE *IpToStr(DWORD dwAddr, TCHAR *szBuffer);
e0f99bf0
VK
621#ifdef UNICODE
622 char LIBNETXMS_EXPORTABLE *IpToStrA(DWORD dwAddr, char *szBuffer);
17b35ccc
VK
623#else
624#define IpToStrA IpToStr
e0f99bf0 625#endif
36e44abe 626 TCHAR LIBNETXMS_EXPORTABLE *Ip6ToStr(BYTE *addr, TCHAR *buffer);
60557d06
VK
627 TCHAR LIBNETXMS_EXPORTABLE *SockaddrToStr(struct sockaddr *addr, TCHAR *buffer);
628
3aa0061c 629 DWORD LIBNETXMS_EXPORTABLE ResolveHostName(const TCHAR *pszName);
08b214c6
VK
630#ifdef UNICODE
631 DWORD LIBNETXMS_EXPORTABLE ResolveHostNameA(const char *pszName);
632#else
633#define ResolveHostNameA ResolveHostName
634#endif
a1dc75b0 635
64584976 636 void LIBNETXMS_EXPORTABLE *nx_memdup(const void *pData, DWORD dwSize);
f218dc6d 637 void LIBNETXMS_EXPORTABLE nx_memswap(void *pBlock1, void *pBlock2, DWORD dwSize);
31521248 638
f42b8099 639 TCHAR LIBNETXMS_EXPORTABLE *BinToStr(const BYTE *pData, DWORD dwSize, TCHAR *pStr);
3aa0061c 640 DWORD LIBNETXMS_EXPORTABLE StrToBin(const TCHAR *pStr, BYTE *pData, DWORD dwSize);
f42b8099 641 TCHAR LIBNETXMS_EXPORTABLE *MACToStr(const BYTE *pData, TCHAR *pStr);
b50f1100 642
018fda4d 643 void LIBNETXMS_EXPORTABLE StrStrip(TCHAR *pszStr);
0bbab9d3 644 void LIBNETXMS_EXPORTABLE Trim(TCHAR *str);
018fda4d 645 BOOL LIBNETXMS_EXPORTABLE MatchString(const TCHAR *pattern, const TCHAR *string, BOOL matchCase);
9eea20df 646 BOOL LIBNETXMS_EXPORTABLE RegexpMatch(const TCHAR *pszStr, const TCHAR *pszExpr, BOOL bMatchCase);
35f836fe 647 const TCHAR LIBNETXMS_EXPORTABLE *ExtractWord(const TCHAR *line, TCHAR *buffer);
f3cdd1c5 648 TCHAR LIBNETXMS_EXPORTABLE **SplitString(const TCHAR *source, TCHAR sep, int *numStrings);
2391d4fd 649 int LIBNETXMS_EXPORTABLE NumChars(const TCHAR *pszStr, int ch);
35f836fe
VK
650 void LIBNETXMS_EXPORTABLE RemoveTrailingCRLFA(char *str);
651 void LIBNETXMS_EXPORTABLE RemoveTrailingCRLFW(WCHAR *str);
652#ifdef UNICODE
653#define RemoveTrailingCRLF RemoveTrailingCRLFW
654#else
655#define RemoveTrailingCRLF RemoveTrailingCRLFA
656#endif
657
f7794b68
VK
658#ifdef __cplusplus
659 BOOL LIBNETXMS_EXPORTABLE IsValidObjectName(const TCHAR *pszName, BOOL bExtendedChars = FALSE);
660#endif
fa2b47a7 661 BOOL LIBNETXMS_EXPORTABLE IsValidScriptName(const TCHAR *pszName);
2391d4fd 662 void LIBNETXMS_EXPORTABLE TranslateStr(TCHAR *pszString, const TCHAR *pszSubStr, const TCHAR *pszReplace);
1a5e0c22 663 const TCHAR LIBNETXMS_EXPORTABLE *GetCleanFileName(const TCHAR *pszFileName);
c3cfc039 664 void LIBNETXMS_EXPORTABLE GetOSVersionString(TCHAR *pszBuffer, int nBufSize);
3aa0061c 665 BYTE LIBNETXMS_EXPORTABLE *LoadFile(const TCHAR *pszFileName, DWORD *pdwFileSize);
08b214c6
VK
666#ifdef UNICODE
667 BYTE LIBNETXMS_EXPORTABLE *LoadFileA(const char *pszFileName, DWORD *pdwFileSize);
668#else
669#define LoadFileA LoadFile
670#endif
671
6120112b 672 DWORD LIBNETXMS_EXPORTABLE CalculateCRC32(const unsigned char *pData, DWORD dwSize, DWORD dwCRC);
a3c76aba 673 void LIBNETXMS_EXPORTABLE CalculateMD5Hash(const unsigned char *data, size_t nbytes, unsigned char *hash);
e0d4b618 674 void LIBNETXMS_EXPORTABLE MD5HashForPattern(const unsigned char *data, size_t patternSize, size_t fullSize, BYTE *hash);
a3c76aba 675 void LIBNETXMS_EXPORTABLE CalculateSHA1Hash(unsigned char *data, size_t nbytes, unsigned char *hash);
e0d4b618 676 void LIBNETXMS_EXPORTABLE SHA1HashForPattern(unsigned char *data, size_t patternSize, size_t fullSize, unsigned char *hash);
3aa0061c
VK
677 BOOL LIBNETXMS_EXPORTABLE CalculateFileMD5Hash(const TCHAR *pszFileName, BYTE *pHash);
678 BOOL LIBNETXMS_EXPORTABLE CalculateFileSHA1Hash(const TCHAR *pszFileName, BYTE *pHash);
679 BOOL LIBNETXMS_EXPORTABLE CalculateFileCRC32(const TCHAR *pszFileName, DWORD *pResult);
66c04cc7 680
4e2debcc
VK
681 void LIBNETXMS_EXPORTABLE ICEEncryptData(const BYTE *in, int inLen, BYTE *out, const BYTE *key);
682 void LIBNETXMS_EXPORTABLE ICEDecryptData(const BYTE *in, int inLen, BYTE *out, const BYTE *key);
683
6b1282e7
VK
684 BOOL LIBNETXMS_EXPORTABLE DecryptPassword(const TCHAR *login, const TCHAR *encryptedPasswd, TCHAR *decryptedPasswd);
685
46ef501a
VK
686 DWORD LIBNETXMS_EXPORTABLE IcmpPing(DWORD dwAddr, int iNumRetries, DWORD dwTimeout,
687 DWORD *pdwRTT, DWORD dwPacketSize);
4826c8a5 688
e6c91aac
VK
689 /* deprecated:
690 DWORD LIBNETXMS_EXPORTABLE NxLoadConfig(const TCHAR *pszFileName, const TCHAR *pszSection,
691 NX_CFG_TEMPLATE *pTemplateList, BOOL bPrint);*/
3aa0061c 692 int LIBNETXMS_EXPORTABLE NxDCIDataTypeFromText(const TCHAR *pszText);
aa13cfd9 693
4560d8bd 694 HMODULE LIBNETXMS_EXPORTABLE DLOpen(const TCHAR *pszLibName, TCHAR *pszErrorText);
aa13cfd9 695 void LIBNETXMS_EXPORTABLE DLClose(HMODULE hModule);
4560d8bd 696 void LIBNETXMS_EXPORTABLE *DLGetSymbolAddr(HMODULE hModule, const TCHAR *pszSymbol, TCHAR *pszErrorText);
aa13cfd9 697
2e06d08b
VK
698 BOOL LIBNETXMS_EXPORTABLE ExtractNamedOptionValue(const TCHAR *optString, const TCHAR *option, TCHAR *buffer, int bufSize);
699 BOOL LIBNETXMS_EXPORTABLE ExtractNamedOptionValueAsBool(const TCHAR *optString, const TCHAR *option, BOOL defVal);
700 long LIBNETXMS_EXPORTABLE ExtractNamedOptionValueAsInt(const TCHAR *optString, const TCHAR *option, long defVal);
ae9cddaf 701
bc858635
VK
702#ifdef __cplusplus
703 const TCHAR LIBNETXMS_EXPORTABLE *CodeToText(int iCode, CODE_TO_TEXT *pTranslator, const TCHAR *pszDefaultText = _T("Unknown"));
704#else
705 const TCHAR LIBNETXMS_EXPORTABLE *CodeToText(int iCode, CODE_TO_TEXT *pTranslator, const TCHAR *pszDefaultText);
706#endif
707
aa13cfd9 708#ifdef _WIN32
4299401e 709 TCHAR LIBNETXMS_EXPORTABLE *GetSystemErrorText(DWORD dwError, TCHAR *pszBuffer, size_t iBufSize);
ccc34207 710 BOOL LIBNETXMS_EXPORTABLE GetWindowsVersionString(TCHAR *versionString, int strSize);
11606542 711 INT64 LIBNETXMS_EXPORTABLE GetProcessRSS();
aa13cfd9 712#endif
696fc54f
VK
713
714#if !(HAVE_DAEMON)
b1a57444 715 int LIBNETXMS_EXPORTABLE daemon(int nochdir, int noclose);
696fc54f 716#endif
4332e9d8 717
3aa0061c 718 DWORD LIBNETXMS_EXPORTABLE inet_addr_w(const WCHAR *pszAddr);
268774a0 719
4332e9d8 720#ifndef _WIN32
664c7c49 721 BOOL LIBNETXMS_EXPORTABLE SetDefaultCodepage(const char *cp);
3aa0061c 722 int LIBNETXMS_EXPORTABLE WideCharToMultiByte(int iCodePage, DWORD dwFlags, const WCHAR *pWideCharStr,
4332e9d8
VK
723 int cchWideChar, char *pByteStr, int cchByteChar,
724 char *pDefaultChar, BOOL *pbUsedDefChar);
3aa0061c 725 int LIBNETXMS_EXPORTABLE MultiByteToWideChar(int iCodePage, DWORD dwFlags, const char *pByteStr,
4332e9d8
VK
726 int cchByteChar, WCHAR *pWideCharStr,
727 int cchWideChar);
04dbaf62 728
6b93c954 729#if !defined(UNICODE_UCS2) || !HAVE_WCSLEN
8b86c5dc 730 int LIBNETXMS_EXPORTABLE ucs2_strlen(const UCS2CHAR *pStr);
6b93c954
VK
731#endif
732#if !defined(UNICODE_UCS2) || !HAVE_WCSNCPY
8b86c5dc 733 UCS2CHAR LIBNETXMS_EXPORTABLE *ucs2_strncpy(UCS2CHAR *pDst, const UCS2CHAR *pSrc, int nDstLen);
6b93c954
VK
734#endif
735#if !defined(UNICODE_UCS2) || !HAVE_WCSDUP
35f836fe 736 UCS2CHAR LIBNETXMS_EXPORTABLE *ucs2__tcsdup(const UCS2CHAR *pStr);
4332e9d8 737#endif
8b86c5dc
VK
738
739#ifndef UNICODE
53c96e2d
VK
740 size_t LIBNETXMS_EXPORTABLE ucs2_to_mb(const UCS2CHAR *src, int srcLen, char *dst, int dstLen);
741 size_t LIBNETXMS_EXPORTABLE mb_to_ucs2(const char *src, int srcLen, UCS2CHAR *dst, int dstLen);
39945910
VK
742 UCS2CHAR LIBNETXMS_EXPORTABLE *UCS2StringFromMBString(const char *pszString);
743 char LIBNETXMS_EXPORTABLE *MBStringFromUCS2String(const UCS2CHAR *pszString);
8b86c5dc
VK
744#endif
745
04dbaf62 746#ifdef UNICODE
6e17f325
VK
747 int LIBNETXMS_EXPORTABLE nx_wprintf(const WCHAR *format, ...);
748 int LIBNETXMS_EXPORTABLE nx_fwprintf(FILE *fp, const WCHAR *format, ...);
749 int LIBNETXMS_EXPORTABLE nx_swprintf(WCHAR *buffer, size_t size, const WCHAR *format, ...);
750 int LIBNETXMS_EXPORTABLE nx_vwprintf(const WCHAR *format, va_list args);
751 int LIBNETXMS_EXPORTABLE nx_vfwprintf(FILE *fp, const WCHAR *format, va_list args);
752 int LIBNETXMS_EXPORTABLE nx_vswprintf(WCHAR *buffer, size_t size, const WCHAR *format, va_list args);
04dbaf62
VK
753#endif
754
3e39fcde 755#endif /* _WIN32 */
8b86c5dc 756
3aa0061c 757 WCHAR LIBNETXMS_EXPORTABLE *WideStringFromMBString(const char *pszString);
c16afb3d 758 WCHAR LIBNETXMS_EXPORTABLE *WideStringFromUTF8String(const char *pszString);
3aa0061c
VK
759 char LIBNETXMS_EXPORTABLE *MBStringFromWideString(const WCHAR *pwszString);
760 char LIBNETXMS_EXPORTABLE *UTF8StringFromWideString(const WCHAR *pwszString);
8b86c5dc 761
3d1058ed
VK
762#ifdef _WITH_ENCRYPTION
763 WCHAR LIBNETXMS_EXPORTABLE *ERR_error_string_W(int nError, WCHAR *pwszBuffer);
764#endif
765
8b86c5dc 766#ifdef UNICODE_UCS4
53c96e2d
VK
767 size_t LIBNETXMS_EXPORTABLE ucs2_to_ucs4(const UCS2CHAR *src, int srcLen, WCHAR *dst, int dstLen);
768 size_t LIBNETXMS_EXPORTABLE ucs4_to_ucs2(const WCHAR *src, int srcLen, UCS2CHAR *dst, int dstLen);
769 size_t LIBNETXMS_EXPORTABLE ucs2_to_utf8(const UCS2CHAR *src, int srcLen, char *dst, int dstLen);
d9b66a56
VK
770 UCS2CHAR LIBNETXMS_EXPORTABLE *UCS2StringFromUCS4String(const WCHAR *pwszString);
771 WCHAR LIBNETXMS_EXPORTABLE *UCS4StringFromUCS2String(const UCS2CHAR *pszString);
b50f1100 772#endif
8b86c5dc 773
d9b66a56
VK
774#ifdef UNICODE
775
8b86c5dc
VK
776#if !HAVE_WFOPEN
777 FILE LIBNETXMS_EXPORTABLE *wfopen(const WCHAR *_name, const WCHAR *_type);
778#endif
779#if !HAVE_WOPEN
780 int LIBNETXMS_EXPORTABLE wopen(const WCHAR *, int, ...);
b50f1100 781#endif
8b86c5dc
VK
782#if !HAVE_WSTAT
783 int wstat(const WCHAR *_path, struct stat *_sbuf);
dde96745 784#endif
ccc34207
VK
785#if !HAVE_WRENAME
786 int wrename(const WCHAR *_oldpath, const WCHAR *_newpath);
787#endif
788#if !HAVE_WUNLINK
789 int wunlink(const WCHAR *_path);
790#endif
273da39a
VK
791#if !HAVE_WGETENV
792 WCHAR *wgetenv(const WCHAR *_string);
793#endif
d49d7500
VK
794#if !HAVE_WCSERROR && HAVE_STRERROR
795 WCHAR *wcserror(int errnum);
796#endif
797#if !HAVE_WCSERROR_R && HAVE_STRERROR_R
b0823d06
VK
798#if HAVE_POSIX_STRERROR_R
799 int wcserror_r(int errnum, WCHAR *strerrbuf, size_t buflen);
800#else
d49d7500
VK
801 WCHAR *wcserror_r(int errnum, WCHAR *strerrbuf, size_t buflen);
802#endif
b0823d06 803#endif
e05f8aaf
VK
804
805#endif /* UNICODE */
806
8b86c5dc
VK
807#if !HAVE_STRTOLL
808 INT64 LIBNETXMS_EXPORTABLE strtoll(const char *nptr, char **endptr, int base);
809#endif
810#if !HAVE_STRTOULL
811 QWORD LIBNETXMS_EXPORTABLE strtoull(const char *nptr, char **endptr, int base);
812#endif
e05f8aaf
VK
813
814#if !HAVE_WCSTOLL
815 INT64 LIBNETXMS_EXPORTABLE wcstoll(const WCHAR *nptr, WCHAR **endptr, int base);
816#endif
817#if !HAVE_WCSTOULL
818 QWORD LIBNETXMS_EXPORTABLE wcstoull(const WCHAR *nptr, WCHAR **endptr, int base);
819#endif
b50f1100 820
3d1cb7d6 821#ifdef _WIN32
5ea2db30
VK
822#ifdef UNICODE
823 DIRW LIBNETXMS_EXPORTABLE *wopendir(const WCHAR *filename);
824 struct dirent_w LIBNETXMS_EXPORTABLE *wreaddir(DIRW *dirp);
825 int LIBNETXMS_EXPORTABLE wclosedir(DIRW *dirp);
826
827#define _topendir wopendir
828#define _treaddir wreaddir
829#define _tclosedir wclosedir
830#else
831#define _topendir opendir
832#define _treaddir readdir
833#define _tclosedir closedir
834#endif
835
3d1cb7d6 836 DIR LIBNETXMS_EXPORTABLE *opendir(const char *filename);
7f9e0c00 837 struct dirent LIBNETXMS_EXPORTABLE *readdir(DIR *dirp);
3d1cb7d6 838 int LIBNETXMS_EXPORTABLE closedir(DIR *dirp);
5ea2db30 839
37d62364 840#endif
3d1cb7d6 841
7f9e0c00
VK
842#if defined(_WIN32) || !(HAVE_SCANDIR)
843 int LIBNETXMS_EXPORTABLE scandir(const char *dir, struct dirent ***namelist,
844 int (*select)(const struct dirent *),
845 int (*compar)(const struct dirent **, const struct dirent **));
846 int LIBNETXMS_EXPORTABLE alphasort(const struct dirent **a, const struct dirent **b);
847#endif
848
55b33d4c
VK
849#ifdef UNDER_CE
850 int LIBNETXMS_EXPORTABLE _topen(TCHAR *pszName, int nFlags, ...);
851 int LIBNETXMS_EXPORTABLE read(int hFile, void *pBuffer, size_t nBytes);
852 int LIBNETXMS_EXPORTABLE write(int hFile, void *pBuffer, size_t nBytes);
853#endif
854
9f2902ac 855BOOL LIBNETXMS_EXPORTABLE nxlog_open(const TCHAR *logName, DWORD flags, const TCHAR *msgModule,
d49d7500 856 unsigned int msgCount, const TCHAR **messages);
9f2902ac
VK
857void LIBNETXMS_EXPORTABLE nxlog_close(void);
858void LIBNETXMS_EXPORTABLE nxlog_write(DWORD msg, WORD wType, const char *format, ...);
4addc3a3
VK
859BOOL LIBNETXMS_EXPORTABLE nxlog_set_rotation_policy(int maxLogSize, int historySize);
860BOOL LIBNETXMS_EXPORTABLE nxlog_rotate();
f669df41
VK
861void LIBNETXMS_EXPORTABLE nxlog_set_console_writer(void (*writer)(const TCHAR *, ...));
862
863void LIBNETXMS_EXPORTABLE WriteToTerminal(const TCHAR *text);
864void LIBNETXMS_EXPORTABLE WriteToTerminalEx(const TCHAR *format, ...);
9f2902ac 865
b50f1100 866#ifdef __cplusplus
e9246d26 867}
b50f1100 868#endif
e9246d26 869
a7ff20a5
VK
870
871//
872// C++ only finctions
873//
874
875#ifdef __cplusplus
876
53c96e2d 877TCHAR LIBNETXMS_EXPORTABLE *EscapeStringForXML(const TCHAR *string, int length);
a7ff20a5 878String LIBNETXMS_EXPORTABLE EscapeStringForXML2(const TCHAR *string, int length = -1);
53c96e2d
VK
879const char LIBNETXMS_EXPORTABLE *XMLGetAttr(const char **attrs, const char *name);
880int LIBNETXMS_EXPORTABLE XMLGetAttrInt(const char **attrs, const char *name, int defVal);
881DWORD LIBNETXMS_EXPORTABLE XMLGetAttrDWORD(const char **attrs, const char *name, DWORD defVal);
882bool LIBNETXMS_EXPORTABLE XMLGetAttrBoolean(const char **attrs, const char *name, bool defVal);
883
884#if !defined(_WIN32) && !defined(_NETWARE) && defined(NMS_THREADS_H_INCLUDED)
885void LIBNETXMS_EXPORTABLE StartMainLoop(THREAD_RESULT (THREAD_CALL * pfSignalHandler)(void *),
886 THREAD_RESULT (THREAD_CALL * pfMain)(void *));
887#endif
888
889void LIBNETXMS_EXPORTABLE InitSubAgentAPI(void (* writeLog)(int, int, const TCHAR *),
890 void (* sendTrap1)(DWORD, const char *, va_list),
891 void (* sendTrap2)(DWORD, int, TCHAR **),
892 BOOL (* sendFile)(void *, DWORD, const TCHAR *, long),
893 BOOL (* pushData)(const TCHAR *, const TCHAR *));
a7ff20a5
VK
894
895#endif
896
e9246d26 897#endif /* _nms_util_h_ */