vdr 2.7.5
tools.h
Go to the documentation of this file.
1/*
2 * tools.h: Various tools
3 *
4 * See the main source file 'vdr.c' for copyright information and
5 * how to reach the author.
6 *
7 * $Id: tools.h 5.12 2025/03/02 11:03:35 kls Exp $
8 */
9
10#ifndef __TOOLS_H
11#define __TOOLS_H
12
13#include <dirent.h>
14#include <errno.h>
15#include <fcntl.h>
16#include <float.h>
17#include <iconv.h>
18#include <math.h>
19#include <poll.h>
20#include <stdarg.h>
21#include <stddef.h>
22#include <stdint.h>
23#include <stdio.h>
24#include <stdlib.h>
25#include <string.h>
26#include <syslog.h>
27#include <sys/stat.h>
28#include <sys/types.h>
29#include "thread.h"
30
31typedef unsigned char uchar;
32
33extern int SysLogLevel;
34
35#define esyslog(a...) void( (SysLogLevel > 0) ? syslog_with_tid(LOG_ERR, a) : void() )
36#define isyslog(a...) void( (SysLogLevel > 1) ? syslog_with_tid(LOG_INFO, a) : void() )
37#define dsyslog(a...) void( (SysLogLevel > 2) ? syslog_with_tid(LOG_DEBUG, a) : void() )
38
39#define LOG_ERROR esyslog("ERROR (%s,%d): %m", __FILE__, __LINE__)
40#define LOG_ERROR_STR(s) esyslog("ERROR (%s,%d): %s: %m", __FILE__, __LINE__, s)
41
42#define SECSINDAY 86400
43
44#define KILOBYTE(n) ((n) * 1024)
45#define MEGABYTE(n) ((n) * 1024LL * 1024LL)
46
47#define MALLOC(type, size) (type *)malloc(sizeof(type) * (size))
48
49template<class T> inline void DELETENULL(T *&p) { T *q = p; p = NULL; delete q; }
50
51#define CHECK(s) { if ((s) < 0) LOG_ERROR; } // used for 'ioctl()' calls
52#define FATALERRNO (errno && errno != EAGAIN && errno != EINTR)
53
54#if __cplusplus >= 201103L
55// any gcc >= 4.8.1; we have swap, min, max
56#include <algorithm> // std::min, std::max, (c++98: also swap)
57#include <utility> // std::swap (since c++11)
58using std::min;
59using std::max;
60using std::swap;
61#else
62// no c++11 and old compiler, let's include our own templates
63template<class T> inline T min(T a, T b) { return a <= b ? a : b; }
64template<class T> inline T max(T a, T b) { return a >= b ? a : b; }
65template<class T> inline void swap(T &a, T &b) { T t = a; a = b; b = t; }
66#endif
67
68template<class T> inline int sgn(T a) { return a < 0 ? -1 : a > 0 ? 1 : 0; }
69
70template<class T> inline T constrain(T v, T l, T h) { return v < l ? l : v > h ? h : v; }
71
72void syslog_with_tid(int priority, const char *format, ...) __attribute__ ((format (printf, 2, 3)));
73
74#define BCDCHARTOINT(x) (10 * ((x & 0xF0) >> 4) + (x & 0xF))
75int BCD2INT(int x);
76
77#define IsBitSet(v, b) ((v) & (1 << (b))) // checks if the bit at index b is set in v, where the least significant bit has index 0
78
79// Unfortunately there are no platform independent macros for unaligned
80// access, so we do it this way:
81
82template<class T> inline T get_unaligned(T *p)
83{
84 struct s { T v; } __attribute__((packed));
85 return ((s *)p)->v;
86}
87
88template<class T> inline void put_unaligned(unsigned int v, T* p)
89{
90 struct s { T v; } __attribute__((packed));
91 ((s *)p)->v = v;
92}
93
94// Comparing doubles for equality is unsafe, but unfortunately we can't
95// overwrite operator==(double, double), so this will have to do:
96
97inline bool DoubleEqual(double a, double b)
98{
99 return fabs(a - b) <= DBL_EPSILON;
100}
101
102// When handling strings that might contain UTF-8 characters, it may be necessary
103// to process a "symbol" that consists of several actual character bytes. The
104// following functions allow transparently accessing a "char *" string without
105// having to worry about what character set is actually used.
106
107int Utf8CharLen(const char *s);
110uint Utf8CharGet(const char *s, int Length = 0);
114int Utf8CharSet(uint c, char *s = NULL);
118int Utf8SymChars(const char *s, int Symbols);
121int Utf8StrLen(const char *s);
124char *Utf8Strn0Cpy(char *Dest, const char *Src, int n);
129int Utf8ToArray(const char *s, uint *a, int Size);
133int Utf8FromArray(const uint *a, char *s, int Size, int Max = -1);
139
140// When allocating buffer space, make sure we reserve enough space to hold
141// a string in UTF-8 representation:
142
143#define Utf8BufSize(s) ((s) * 4 + 1)
144
145// The following macros automatically use the correct versions of the character
146// class functions:
147
148#define Utf8to(conv, c) (cCharSetConv::SystemCharacterTable() ? to##conv(c) : tow##conv(c))
149#define Utf8is(ccls, c) (cCharSetConv::SystemCharacterTable() ? is##ccls(c) : isw##ccls(c))
150
152private:
153 iconv_t cd;
154 char *result;
155 size_t length;
157public:
158 cCharSetConv(const char *FromCode = NULL, const char *ToCode = NULL);
164 const char *Convert(const char *From, char *To = NULL, size_t ToLength = 0);
174 static const char *SystemCharacterTable(void) { return systemCharacterTable; }
175 static void SetSystemCharacterTable(const char *CharacterTable);
176 };
177
178class cString {
179private:
180 char *s;
181public:
182 cString(const char *S = NULL, bool TakePointer = false);
183 cString(const char *S, const char *To);
184 cString(const cString &String);
185 cString(cString &&String): s(String.s) { String.s = NULL; }
186 virtual ~cString();
187 operator const void * () const { return s; } // to catch cases where operator*() should be used
188 operator const char * () const { return s; } // for use in (const char *) context
189 const char * operator*() const { return s; } // for use in (const void *) context (printf() etc.)
190 cString &operator=(const cString &String);
191 cString &operator=(cString &&String);
192 cString &operator=(const char *String);
193 cString &Append(const char *String);
194 cString &Append(char c);
195 cString &Truncate(int Index);
196 cString &CompactChars(char c);
197 static cString sprintf(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
198 static cString vsprintf(const char *fmt, va_list &ap);
199 };
200
202private:
203 char *p;
204 char c;
205public:
207 p = NULL;
208 c = 0;
209 }
211 Set(s);
212 }
214 if (p)
215 *p = c;
216 }
217 void Set(char *s) {
218 if (s) {
219 p = s;
220 c = *s;
221 *s = 0;
222 }
223 else
224 p = NULL;
225 }
226 };
227
228ssize_t safe_read(int filedes, void *buffer, size_t size);
229ssize_t safe_write(int filedes, const void *buffer, size_t size);
230void writechar(int filedes, char c);
231int WriteAllOrNothing(int fd, const uchar *Data, int Length, int TimeoutMs = 0, int RetryMs = 0);
235char *strcpyrealloc(char *dest, const char *src);
236char *strn0cpy(char *dest, const char *src, size_t n);
237char *strreplace(char *s, char c1, char c2);
238char *strreplace(char *s, const char *s1, const char *s2);
239const char *strchrn(const char *s, char c, size_t n);
240int strcountchr(const char *s, char c);
241cString strgetbefore(const char *s, char c, int n = 1); // returns the part of 's' before (and excluding) the n'th occurrence of 'c' from the right, or an empty string if there is no such 'c'.
242const char *strgetlast(const char *s, char c); // returns the part of 's' after the last occurrence of 'c', or 's' if there is no 'c'.
243inline char *strgetlast(char *s, char c) { return const_cast<char *>(strgetlast(static_cast<const char *>(s), c)); } // returns the part of 's' after the last occurrence of 'c', or 's' if there is no 'c'.
244inline char *skipspace(const char *s)
245{
246 if ((uchar)*s > ' ') // most strings don't have any leading space, so handle this case as fast as possible
247 return (char *)s;
248 while (*s && (uchar)*s <= ' ') // avoiding isspace() here, because it is much slower
249 s++;
250 return (char *)s;
251}
252char *stripspace(char *s);
253char *compactspace(char *s);
254char *compactchars(char *s, char c);
255cString strescape(const char *s, const char *chars);
256cString strgetval(const char *s, const char *name, char d = '=');
264char *strshift(char *s, int n);
270bool startswith(const char *s, const char *p);
271bool endswith(const char *s, const char *p);
272bool isempty(const char *s);
273int numdigits(int n);
274bool isnumber(const char *s);
275int64_t StrToNum(const char *s);
281bool StrInArray(const char *a[], const char *s);
284double atod(const char *s);
288cString dtoa(double d, const char *Format = "%f");
292cString itoa(int n);
293inline uint16_t Peek13(const uchar *p)
294{
295 uint16_t v = uint16_t(*p++ & 0x1F) << 8;
296 return v + (*p & 0xFF);
297}
298inline void Poke13(uchar *p, uint16_t v)
299{
300 v |= uint16_t(*p & ~0x1F) << 8;
301 *p++ = v >> 8;
302 *p = v & 0xFF;
303}
304cString AddDirectory(const char *DirName, const char *FileName);
305bool EntriesOnSameFileSystem(const char *File1, const char *File2);
309int FreeDiskSpaceMB(const char *Directory, int *UsedMB = NULL);
310bool DirectoryOk(const char *DirName, bool LogErrors = false);
311bool MakeDirs(const char *FileName, bool IsDirectory = false);
312bool RemoveFileOrDir(const char *FileName, bool FollowSymlinks = false);
313bool RemoveEmptyDirectories(const char *DirName, bool RemoveThis = false, const char *IgnoreFiles[] = NULL);
319int DirSizeMB(const char *DirName);
320char *ReadLink(const char *FileName);
321bool SpinUpDisk(const char *FileName);
322void TouchFile(const char *FileName, bool Create = false);
323time_t LastModifiedTime(const char *FileName);
324off_t FileSize(const char *FileName);
325cString WeekDayName(int WeekDay);
328cString WeekDayName(time_t t);
330cString WeekDayNameFull(int WeekDay);
333cString WeekDayNameFull(time_t t);
335cString DayDateTime(time_t t = 0);
338cString TimeToString(time_t t);
340cString DateString(time_t t);
342cString ShortDateString(time_t t);
344cString TimeString(time_t t);
346uchar *RgbToJpeg(uchar *Mem, int Width, int Height, int &Size, int Quality = 100);
355const char *GetHostName(void);
357
359private:
360 const uchar *data;
363 int i;
364 char *result;
365 static const char *b64;
366public:
367 cBase64Encoder(const uchar *Data, int Length, int MaxResult = 64);
374 const char *NextLine(void);
380 };
381
383private:
384 const uint8_t *data;
385 int length; // in bits
386 int index; // in bits
387public:
388 cBitStream(const uint8_t *Data, int Length) : data(Data), length(Length), index(0) {}
390 int GetBit(void);
391 uint32_t GetBits(int n);
392 void ByteAlign(void);
393 void WordAlign(void);
394 bool SetLength(int Length);
395 void SkipBits(int n) { index += n; }
396 void SkipBit(void) { SkipBits(1); }
397 bool IsEOF(void) const { return index >= length; }
398 void Reset(void) { index = 0; }
399 int Length(void) const { return length; }
400 int Index(void) const { return (IsEOF() ? length : index); }
401 const uint8_t *GetData(void) const { return (IsEOF() ? NULL : data + (index / 8)); }
402 };
403
404class cTimeMs {
405private:
406 uint64_t begin;
407public:
408 cTimeMs(int Ms = 0);
412 static uint64_t Now(void);
413 void Set(int Ms = 0);
420 bool TimedOut(void) const;
421 uint64_t Elapsed(void) const;
422 };
423
425private:
426 size_t size;
427 char *buffer;
428public:
429 cReadLine(void);
430 ~cReadLine();
431 char *Read(FILE *f);
432 };
433
434class cPoller {
435private:
436 enum { MaxPollFiles = 64 };
439public:
440 cPoller(int FileHandle = -1, bool Out = false);
441 bool Add(int FileHandle, bool Out);
442 void Del(int FileHandle, bool Out);
443 bool Poll(int TimeoutMs = 0);
444 };
445
446class cReadDir {
447private:
449 struct dirent *result;
450#if !__GLIBC_PREREQ(2, 24) // readdir_r() is deprecated as of GLIBC 2.24
451 union { // according to "The GNU C Library Reference Manual"
452 struct dirent d;
453 char b[offsetof(struct dirent, d_name) + NAME_MAX + 1];
454 } u;
455#endif
456public:
457 cReadDir(const char *Directory);
458 ~cReadDir();
459 bool Ok(void) { return directory != NULL; }
460 struct dirent *Next(void);
461 };
462
463class cFile {
464private:
465 int f;
466public:
467 cFile(void);
468 ~cFile();
469 operator int () { return f; }
470 bool Open(const char *FileName, int Flags, mode_t Mode = DEFFILEMODE);
471 bool Open(int FileDes);
472 void Close(void);
473 bool IsOpen(void) { return f >= 0; }
474 bool Ready(bool Wait = true);
475 static bool FileReady(int FileDes, int TimeoutMs = 1000);
476 };
477
479private:
480 FILE *f;
481 char *fileName;
482 char *tempName;
483public:
484 cSafeFile(const char *FileName);
485 ~cSafeFile();
486 operator FILE* () { return f; }
487 bool Open(void);
488 bool Close(void);
489 };
490
493
495private:
496 int fd;
497 off_t curpos;
500 off_t begin;
501 off_t lastpos;
502 off_t ahead;
503 size_t readahead;
504 size_t written;
506 int FadviseDrop(off_t Offset, off_t Len);
507public:
508 cUnbufferedFile(void);
510 int Open(const char *FileName, int Flags, mode_t Mode = DEFFILEMODE);
511 int Close(void);
512 void SetReadAhead(size_t ra);
513 off_t Seek(off_t Offset, int Whence);
514 ssize_t Read(void *Data, size_t Size);
515 ssize_t Write(const void *Data, size_t Size);
516 static cUnbufferedFile *Create(const char *FileName, int Flags, mode_t Mode = DEFFILEMODE);
517 };
518
520private:
521 char *fileName;
522 int f;
523public:
524 cLockFile(const char *Directory);
525 ~cLockFile();
526 bool Lock(int WaitSeconds = 0);
527 void Unlock(void);
528 };
529
532private:
534 cListObject(const cListObject &ListObject) { abort(); } // no copy constructor!
535 cListObject& operator= (const cListObject &ListObject) { abort(); return *this; } // no assignment operator!
536public:
537 cListObject(void);
538 virtual ~cListObject();
539 virtual int Compare(const cListObject &ListObject) const { return 0; }
542 void Append(cListObject *Object);
543 void Insert(cListObject *Object);
544 void Unlink(void);
545 int Index(void) const;
546 cListObject *Prev(void) const { return prev; }
547 cListObject *Next(void) const { return next; }
548 };
549
551private:
554 time_t lastPut;
555public:
558 void Put(cListObject *Object);
559 void Purge(bool Force = false);
560 };
561
563
565protected:
567 int count;
569 const char *needsLocking;
571 cListBase(const char *NeedsLocking = NULL);
572public:
573 virtual ~cListBase();
574 bool Lock(cStateKey &StateKey, bool Write = false, int TimeoutMs = 0) const;
599 void SetSyncStateKey(cStateKey &StateKey) { stateLock.SetSyncStateKey(StateKey); }
605 void SetExplicitModify(void);
610 void SetModified(void);
612 void Add(cListObject *Object, cListObject *After = NULL);
613 void Ins(cListObject *Object, cListObject *Before = NULL);
614 void Del(cListObject *Object, bool DeleteObject = true);
615 virtual void Move(int From, int To);
616 void Move(cListObject *From, cListObject *To);
617 virtual void Clear(void);
618 bool Contains(const cListObject *Object) const;
625 const cListObject *Get(int Index) const;
626 cListObject *Get(int Index) { return const_cast<cListObject *>(static_cast<const cListBase *>(this)->Get(Index)); }
627 int Count(void) const { return count; }
628 void Sort(void);
629 };
630
631template<class T> class cList : public cListBase {
632public:
633 cList(const char *NeedsLocking = NULL): cListBase(NeedsLocking) {}
640 const T *Get(int Index) const { return (T *)cListBase::Get(Index); }
643 const T *First(void) const { return (T *)objects; }
645 const T *Last(void) const { return (T *)lastObject; }
647 const T *Prev(const T *Object) const { return (T *)Object->cListObject::Prev(); } // need to call cListObject's members to
650 const T *Next(const T *Object) const { return (T *)Object->cListObject::Next(); } // avoid ambiguities in case of a "list of lists"
653 T *Get(int Index) { return const_cast<T *>(static_cast<const cList<T> *>(this)->Get(Index)); }
655 T *First(void) { return const_cast<T *>(static_cast<const cList<T> *>(this)->First()); }
657 T *Last(void) { return const_cast<T *>(static_cast<const cList<T> *>(this)->Last()); }
659 T *Prev(const T *Object) { return const_cast<T *>(static_cast<const cList<T> *>(this)->Prev(Object)); }
661 T *Next(const T *Object) { return const_cast<T *>(static_cast<const cList<T> *>(this)->Next(Object)); }
663 };
664
665// The DEF_LIST_LOCK macro defines a convenience class that can be used to obtain
666// a lock on a cList and make sure the lock is released when the current scope
667// is left:
668
669#define DEF_LIST_LOCK2(Class, Name) \
670class c##Name##_Lock { \
671private: \
672 cStateKey stateKey; \
673 const c##Class *list; \
674public: \
675 c##Name##_Lock(bool Write = false) \
676 { \
677 if (Write) \
678 list = c##Class::Get##Name##Write(stateKey); \
679 else \
680 list = c##Class::Get##Name##Read(stateKey); \
681 } \
682 ~c##Name##_Lock() { if (list) stateKey.Remove(); } \
683 const c##Class *Name(void) const { return list; } \
684 c##Class *Name(void) { return const_cast<c##Class *>(list); } \
685 }
686#define DEF_LIST_LOCK(Class) DEF_LIST_LOCK2(Class, Class)
687
688// The USE_LIST_LOCK macro sets up a local variable of a class defined by
689// a suitable DEF_LIST_LOCK, and also a pointer to the provided list:
690
691#define USE_LIST_LOCK_READ2(Class, Name) \
692c##Name##_Lock Name##_Lock(false); \
693const c##Class *Name __attribute__((unused)) = Name##_Lock.Name();
694#define USE_LIST_LOCK_READ(Class) USE_LIST_LOCK_READ2(Class, Class)
695
696#define USE_LIST_LOCK_WRITE2(Class, Name) \
697c##Name##_Lock Name##_Lock(true); \
698c##Class *Name __attribute__((unused)) = Name##_Lock.Name();
699#define USE_LIST_LOCK_WRITE(Class) USE_LIST_LOCK_WRITE2(Class, Class)
700
701template<class T> class cVector {
703private:
704 mutable int allocated;
705 mutable int size;
706 mutable T *data;
707 cVector(const cVector &Vector) {} // don't copy...
708 cVector &operator=(const cVector &Vector) { return *this; } // ...or assign this!
709 void Realloc(int Index) const
710 {
711 if (++Index > allocated) {
712 data = (T *)realloc(data, Index * sizeof(T));
713 if (!data) {
714 esyslog("ERROR: out of memory - abort!");
715 abort();
716 }
717 for (int i = allocated; i < Index; i++)
718 data[i] = T(0);
719 allocated = Index;
720 }
721 }
722public:
723 cVector(int Allocated = 10)
724 {
725 allocated = 0;
726 size = 0;
727 data = NULL;
728 Realloc(Allocated);
729 }
730 virtual ~cVector() { free(data); }
731 T& At(int Index) const
732 {
733 Realloc(Index);
734 if (Index >= size)
735 size = Index + 1;
736 return data[Index];
737 }
738 const T& operator[](int Index) const
739 {
740 return At(Index);
741 }
742 T& operator[](int Index)
743 {
744 return At(Index);
745 }
746 int IndexOf(const T &Data) // returns the index of Data, or -1 if not found
747 {
748 for (int i = 0; i < size; i++) {
749 if (data[i] == Data)
750 return i;
751 }
752 return -1;
753 }
754 int Size(void) const { return size; }
755 virtual void Insert(T Data, int Before = 0)
756 {
757 if (Before < size) {
758 Realloc(size);
759 memmove(&data[Before + 1], &data[Before], (size - Before) * sizeof(T));
760 size++;
761 data[Before] = Data;
762 }
763 else
764 Append(Data);
765 }
766 bool InsertUnique(T Data, int Before = 0)
767 {
768 if (IndexOf(Data) < 0) {
769 Insert(Data, Before);
770 return true;
771 }
772 return false;
773 }
774 virtual void Append(T Data)
775 {
776 if (size >= allocated)
777 Realloc(allocated * 3 / 2); // increase size by 50%
778 data[size++] = Data;
779 }
780 bool AppendUnique(T Data)
781 {
782 if (IndexOf(Data) < 0) {
783 Append(Data);
784 return true;
785 }
786 return false;
787 }
788 virtual void Remove(int Index)
789 {
790 if (Index < 0)
791 return; // prevents out-of-bounds access
792 if (Index < size - 1)
793 memmove(&data[Index], &data[Index + 1], (size - Index) * sizeof(T));
794 size--;
795 }
796 bool RemoveElement(const T &Data)
797 {
798 int i = IndexOf(Data);
799 if (i >= 0) {
800 Remove(i);
801 return true;
802 }
803 return false;
804 }
805 virtual void Clear(void)
806 {
807 for (int i = 0; i < size; i++)
808 data[i] = T(0);
809 size = 0;
810 }
811 void Sort(__compar_fn_t Compare)
812 {
813 qsort(data, size, sizeof(T), Compare);
814 }
815 };
816
817inline int CompareInts(const void *a, const void *b)
818{
819 return *(const int *)a - *(const int *)b;
820}
821
822inline int CompareStrings(const void *a, const void *b)
823{
824 return strcmp(*(const char **)a, *(const char **)b);
825}
826
827inline int CompareStringsIgnoreCase(const void *a, const void *b)
828{
829 return strcasecmp(*(const char **)a, *(const char **)b);
830}
831
832inline int CompareStringsNumerically(const void *a, const void *b)
833{
834 int d = atoi(*(const char **)a) - atoi(*(const char **)b);
835 return d ? d : CompareStrings(a, b);
836}
837
838class cStringList : public cVector<char *> {
839public:
840 cStringList(int Allocated = 10): cVector<char *>(Allocated) {}
841 virtual ~cStringList() override;
842 int Find(const char *s) const;
843 void Sort(bool IgnoreCase = false)
844 {
845 if (IgnoreCase)
847 else
849 }
854 virtual void Clear(void) override;
855 };
856
858public:
859 cFileNameList(const char *Directory = NULL, bool DirsOnly = false);
860 bool Load(const char *Directory, bool DirsOnly = false);
861 };
862
864private:
867 int size; // the total size of the buffer (bytes in memory)
868 int used; // the number of used bytes, starting at the beginning of the buffer
869 bool Realloc(int NewSize);
870 bool Assert(int NewSize) { return size < NewSize ? Realloc(NewSize) : true; } // inline for performance!
871public:
872 cDynamicBuffer(int InitialSize = 1024);
874 void Append(const uchar *Data, int Length);
875 void Append(uchar Data) { if (Assert(used + 1)) buffer[used++] = Data; }
876 void Set(int Index, uchar Data) { if (Assert(Index + 1)) buffer[Index] = Data; }
877 uchar Get(int Index) { return Index < used ? buffer[Index] : 0; }
878 void Clear(void) { used = 0; }
879 uchar *Data(void) { return buffer; }
880 int Length(void) { return used; }
881 };
882
883class cHashObject : public cListObject {
884 friend class cHashBase;
885private:
886 unsigned int id;
888public:
889 cHashObject(cListObject *Object, unsigned int Id) { object = Object; id = Id; }
890 cListObject *Object(void) { return object; }
891 };
892
894private:
896 int size;
898 unsigned int hashfn(unsigned int Id) const { return Id % size; }
899protected:
900 cHashBase(int Size, bool OwnObjects);
905public:
906 virtual ~cHashBase();
907 void Add(cListObject *Object, unsigned int Id);
908 void Del(cListObject *Object, unsigned int Id);
909 void Clear(void);
910 cListObject *Get(unsigned int Id) const;
911 cList<cHashObject> *GetList(unsigned int Id) const;
912 };
913
914#define HASHSIZE 512
915
916template<class T> class cHash : public cHashBase {
917public:
918 cHash(int Size = HASHSIZE, bool OwnObjects = false) : cHashBase(Size, OwnObjects) {}
919 T *Get(unsigned int Id) const { return (T *)cHashBase::Get(Id); }
920};
921
922#endif //__TOOLS_H
static uint8_t * SetLength(uint8_t *Data, int Length)
Definition ci.c:57
char * result
Definition tools.h:364
cBase64Encoder(const uchar *Data, int Length, int MaxResult=64)
Sets up a new base 64 encoder for the given Data, with the given Length.
Definition tools.c:1425
const char * NextLine(void)
Returns the next line of encoded data (terminated by '\0'), or NULL if there is no more encoded data.
Definition tools.c:1439
const uchar * data
Definition tools.h:360
int maxResult
Definition tools.h:362
static const char * b64
Definition tools.h:365
void SkipBit(void)
Definition tools.h:396
int Index(void) const
Definition tools.h:400
cBitStream(const uint8_t *Data, int Length)
Definition tools.h:388
int length
Definition tools.h:385
const uint8_t * data
Definition tools.h:384
int index
Definition tools.h:386
int Length(void) const
Definition tools.h:399
bool IsEOF(void) const
Definition tools.h:397
const uint8_t * GetData(void) const
Definition tools.h:401
void SkipBits(int n)
Definition tools.h:395
~cBitStream()
Definition tools.h:389
void Reset(void)
Definition tools.h:398
cCharSetConv(const char *FromCode=NULL, const char *ToCode=NULL)
Sets up a character set converter to convert from FromCode to ToCode.
Definition tools.c:988
static const char * SystemCharacterTable(void)
Definition tools.h:174
static void SetSystemCharacterTable(const char *CharacterTable)
Definition tools.c:1006
char * result
Definition tools.h:154
size_t length
Definition tools.h:155
iconv_t cd
Definition tools.h:153
static char * systemCharacterTable
Definition tools.h:156
~cCharSetConv()
Definition tools.c:999
const char * Convert(const char *From, char *To=NULL, size_t ToLength=0)
Converts the given Text from FromCode to ToCode (as set in the constructor).
Definition tools.c:1029
cDynamicBuffer(int InitialSize=1024)
Definition tools.c:2323
void Set(int Index, uchar Data)
Definition tools.h:876
uchar Get(int Index)
Definition tools.h:877
bool Realloc(int NewSize)
Definition tools.c:2335
int Length(void)
Definition tools.h:880
uchar * Data(void)
Definition tools.h:879
uchar * buffer
Definition tools.h:865
void Clear(void)
Definition tools.h:878
bool Assert(int NewSize)
Definition tools.h:870
void Append(uchar Data)
Definition tools.h:875
int initialSize
Definition tools.h:866
bool Load(const char *Directory, bool DirsOnly=false)
Definition tools.c:1654
cFileNameList(const char *Directory=NULL, bool DirsOnly=false)
Definition tools.c:1649
cFile(void)
Definition tools.c:1682
bool IsOpen(void)
Definition tools.h:473
int f
Definition tools.h:465
cListObject * Get(unsigned int Id) const
Definition tools.c:2410
cList< cHashObject > ** hashTable
Definition tools.h:895
int size
Definition tools.h:896
bool ownObjects
Definition tools.h:897
cHashBase(int Size, bool OwnObjects)
Creates a new hash of the given Size.
Definition tools.c:2361
unsigned int hashfn(unsigned int Id) const
Definition tools.h:898
friend class cHashBase
Definition tools.h:884
unsigned int id
Definition tools.h:886
cListObject * object
Definition tools.h:887
cListObject * Object(void)
Definition tools.h:890
cHashObject(cListObject *Object, unsigned int Id)
Definition tools.h:889
cHash(int Size=HASHSIZE, bool OwnObjects=false)
Definition tools.h:918
T * Get(unsigned int Id) const
Definition tools.h:919
cListObject * lastObject
Definition tools.h:566
cStateLock stateLock
Definition tools.h:568
bool useGarbageCollector
Definition tools.h:570
cListObject * Get(int Index)
Definition tools.h:626
void SetSyncStateKey(cStateKey &StateKey)
When making changes to this list (while holding a write lock) that shall not affect some other code t...
Definition tools.h:599
void SetUseGarbageCollector(void)
Definition tools.h:604
bool Lock(cStateKey &StateKey, bool Write=false, int TimeoutMs=0) const
Tries to get a lock on this list and returns true if successful.
Definition tools.c:2166
int count
Definition tools.h:567
cListObject * objects
Definition tools.h:566
const char * needsLocking
Definition tools.h:569
cListBase(const char *NeedsLocking=NULL)
Definition tools.c:2152
const cListObject * Get(int Index) const
Definition tools.c:2282
int Count(void) const
Definition tools.h:627
void Purge(bool Force=false)
Definition tools.c:2134
cListGarbageCollector(void)
Definition tools.c:2113
cListObject * objects
Definition tools.h:553
void Put(cListObject *Object)
Definition tools.c:2125
cListObject(const cListObject &ListObject)
Definition tools.h:534
cListObject * next
Definition tools.h:533
cListObject * Prev(void) const
Definition tools.h:546
friend class cListGarbageCollector
Definition tools.h:531
cListObject * prev
Definition tools.h:533
virtual int Compare(const cListObject &ListObject) const
Must return 0 if this object is equal to ListObject, a positive value if it is "greater",...
Definition tools.h:539
cListObject * Next(void) const
Definition tools.h:547
Definition tools.h:631
T * Last(void)
Non-const version of Last().
Definition tools.h:657
T * Prev(const T *Object)
Non-const version of Prev().
Definition tools.h:659
T * First(void)
Non-const version of First().
Definition tools.h:655
const T * Prev(const T *Object) const
Definition tools.h:647
T * Get(int Index)
< Returns the element immediately following Object in this list, or NULL if Object is the last elemen...
Definition tools.h:653
const T * First(void) const
Returns the first element in this list, or NULL if the list is empty.
Definition tools.h:643
T * Next(const T *Object)
Non-const version of Next().
Definition tools.h:661
cList(const char *NeedsLocking=NULL)
Sets up a new cList of the given type T.
Definition tools.h:633
const T * Next(const T *Object) const
< Returns the element immediately before Object in this list, or NULL if Object is the first element ...
Definition tools.h:650
const T * Last(void) const
Returns the last element in this list, or NULL if the list is empty.
Definition tools.h:645
const T * Get(int Index) const
Returns the list element at the given Index, or NULL if no such element exists.
Definition tools.h:640
bool Lock(int WaitSeconds=0)
Definition tools.c:2014
void Unlock(void)
Definition tools.c:2054
char * fileName
Definition tools.h:521
int f
Definition tools.h:522
cLockFile(const char *Directory)
Definition tools.c:2000
char * p
Definition tools.h:203
void Set(char *s)
Definition tools.h:217
cNullTerminate(char *s)
Definition tools.h:210
cNullTerminate(void)
Definition tools.h:206
~cNullTerminate()
Definition tools.h:213
cPoller(int FileHandle=-1, bool Out=false)
Definition tools.c:1547
int numFileHandles
Definition tools.h:438
bool Add(int FileHandle, bool Out)
Definition tools.c:1553
bool Poll(int TimeoutMs=0)
Definition tools.c:1585
void Del(int FileHandle, bool Out)
Definition tools.c:1572
pollfd pfd[MaxPollFiles]
Definition tools.h:437
@ MaxPollFiles
Definition tools.h:436
struct dirent * result
Definition tools.h:449
cReadDir(const char *Directory)
Definition tools.c:1597
DIR * directory
Definition tools.h:448
struct dirent d
Definition tools.h:452
bool Ok(void)
Definition tools.h:459
char b[offsetof(struct dirent, d_name)+NAME_MAX+1]
Definition tools.h:453
cReadLine(void)
Definition tools.c:1516
char * buffer
Definition tools.h:427
size_t size
Definition tools.h:426
char * Read(FILE *f)
Definition tools.c:1527
char * tempName
Definition tools.h:482
char * fileName
Definition tools.h:481
FILE * f
Definition tools.h:480
cSafeFile(const char *FileName)
Definition tools.c:1741
cStringList(int Allocated=10)
Definition tools.h:840
void Sort(bool IgnoreCase=false)
Definition tools.h:843
void SortNumerically(void)
Definition tools.h:850
cString & CompactChars(char c)
Compact any sequence of characters 'c' to a single character, and strip all of them from the beginnin...
Definition tools.c:1189
static cString static cString vsprintf(const char *fmt, va_list &ap)
Definition tools.c:1208
virtual ~cString()
Definition tools.c:1115
const char * operator*() const
Definition tools.h:189
cString(const char *S=NULL, bool TakePointer=false)
Definition tools.c:1091
static cString sprintf(const char *fmt,...) __attribute__((format(printf
Definition tools.c:1195
cString & operator=(const cString &String)
Definition tools.c:1120
cString(cString &&String)
Definition tools.h:185
char * s
Definition tools.h:180
cString & Append(const char *String)
Definition tools.c:1148
cString & Truncate(int Index)
Truncate the string at the given Index (if Index is < 0 it is counted from the end of the string).
Definition tools.c:1179
uint64_t Elapsed(void) const
Definition tools.c:818
void Set(int Ms=0)
Sets the timer.
Definition tools.c:808
bool TimedOut(void) const
Definition tools.c:813
cTimeMs(int Ms=0)
Creates a timer with ms resolution and an initial timeout of Ms.
Definition tools.c:757
uint64_t begin
Definition tools.h:406
static uint64_t Now(void)
Definition tools.c:765
off_t ahead
Definition tools.h:502
off_t begin
Definition tools.h:500
size_t readahead
Definition tools.h:503
static cUnbufferedFile * Create(const char *FileName, int Flags, mode_t Mode=DEFFILEMODE)
Definition tools.c:1985
void SetReadAhead(size_t ra)
Definition tools.c:1857
size_t totwritten
Definition tools.h:505
off_t lastpos
Definition tools.h:501
off_t cachedstart
Definition tools.h:498
ssize_t Write(const void *Data, size_t Size)
Definition tools.c:1934
int Close(void)
Definition tools.c:1833
off_t cachedend
Definition tools.h:499
int Open(const char *FileName, int Flags, mode_t Mode=DEFFILEMODE)
Definition tools.c:1815
ssize_t Read(void *Data, size_t Size)
Definition tools.c:1876
int FadviseDrop(off_t Offset, off_t Len)
Definition tools.c:1862
off_t Seek(off_t Offset, int Whence)
Definition tools.c:1868
cUnbufferedFile(void)
Definition tools.c:1805
size_t written
Definition tools.h:504
off_t curpos
Definition tools.h:497
int Size(void) const
Definition tools.h:754
cVector(int Allocated=10)
Definition tools.h:723
bool AppendUnique(T Data)
Definition tools.h:780
void Realloc(int Index) const
Definition tools.h:709
void Sort(__compar_fn_t Compare)
Definition tools.h:811
int IndexOf(const T &Data)
Definition tools.h:746
T & operator[](int Index)
Definition tools.h:742
cVector & operator=(const cVector &Vector)
Definition tools.h:708
int allocated
< cVector may only be used for simple types, like int or pointers - not for class objects that alloca...
Definition tools.h:704
virtual void Clear(void)
Definition tools.h:805
virtual ~cVector()
Definition tools.h:730
virtual void Insert(T Data, int Before=0)
Definition tools.h:755
T * data
Definition tools.h:706
virtual void Append(T Data)
Definition tools.h:774
bool InsertUnique(T Data, int Before=0)
Definition tools.h:766
int size
Definition tools.h:705
T & At(int Index) const
Definition tools.h:731
virtual void Remove(int Index)
Definition tools.h:788
const T & operator[](int Index) const
Definition tools.h:738
bool RemoveElement(const T &Data)
Definition tools.h:796
cVector(const cVector &Vector)
Definition tools.h:707
struct __attribute__((packed))
Definition recording.c:2736
int SysLogLevel
Definition tools.c:31
cListGarbageCollector ListGarbageCollector
Definition tools.c:2111
char * ReadLink(const char *FileName)
returns a new string allocated on the heap, which the caller must delete (or NULL in case of an error...
Definition tools.c:679
char * strcpyrealloc(char *dest, const char *src)
Definition tools.c:114
const char * strgetlast(const char *s, char c)
Definition tools.c:221
cString TimeString(time_t t)
Converts the given time to a string of the form "hh:mm".
Definition tools.c:1301
cString WeekDayNameFull(int WeekDay)
Converts the given WeekDay (0=Sunday, 1=Monday, ...) to a full day name.
Definition tools.c:1239
T get_unaligned(T *p)
Definition tools.h:82
char * compactchars(char *s, char c)
removes all occurrences of 'c' from the beginning an end of 's' and replaces sequences of multiple 'c...
Definition tools.c:256
void TouchFile(const char *FileName, bool Create=false)
Definition tools.c:725
T constrain(T v, T l, T h)
Definition tools.h:70
char * Utf8Strn0Cpy(char *Dest, const char *Src, int n)
Copies at most n character bytes from Src to Dest, making sure that the resulting copy ends with a co...
Definition tools.c:915
bool isempty(const char *s)
Definition tools.c:357
int Utf8ToArray(const char *s, uint *a, int Size)
Converts the given character bytes (including the terminating 0) into an array of UTF-8 symbols of th...
Definition tools.c:938
char * strreplace(char *s, char c1, char c2)
Definition tools.c:142
#define HASHSIZE
Definition tools.h:914
cString strescape(const char *s, const char *chars)
Definition tools.c:280
int strcountchr(const char *s, char c)
returns the number of occurrences of 'c' in 's'.
Definition tools.c:199
cString TimeToString(time_t t)
Converts the given time to a string of the form "www mmm dd hh:mm:ss yyyy".
Definition tools.c:1271
bool RemoveEmptyDirectories(const char *DirName, bool RemoveThis=false, const char *IgnoreFiles[]=NULL)
Removes all empty directories under the given directory DirName.
Definition tools.c:593
bool SpinUpDisk(const char *FileName)
Definition tools.c:693
int Utf8StrLen(const char *s)
Returns the number of UTF-8 symbols formed by the given string of character bytes.
Definition tools.c:903
int Utf8CharSet(uint c, char *s=NULL)
Converts the given UTF-8 symbol to a sequence of character bytes and copies them to the given string.
Definition tools.c:856
cString strgetbefore(const char *s, char c, int n=1)
Definition tools.c:211
uint16_t Peek13(const uchar *p)
Definition tools.h:293
cString WeekDayName(int WeekDay)
Converts the given WeekDay (0=Sunday, 1=Monday, ...) to a three letter day name.
Definition tools.c:1218
bool MakeDirs(const char *FileName, bool IsDirectory=false)
Definition tools.c:507
bool startswith(const char *s, const char *p)
Definition tools.c:337
unsigned char uchar
Definition tools.h:31
char * strshift(char *s, int n)
Shifts the given string to the left by the given number of bytes, thus removing the first n bytes fro...
Definition tools.c:325
const char * GetHostName(void)
Gets the host name of this machine.
Definition tools.c:1409
cString strgetval(const char *s, const char *name, char d='=')
Returns the value part of a 'name=value' pair in s.
Definition tools.c:303
int CompareStrings(const void *a, const void *b)
Definition tools.h:822
int CompareInts(const void *a, const void *b)
Definition tools.h:817
uchar * RgbToJpeg(uchar *Mem, int Width, int Height, int &Size, int Quality=100)
Converts the given Memory to a JPEG image and returns a pointer to the resulting image.
Definition tools.c:1366
int WriteAllOrNothing(int fd, const uchar *Data, int Length, int TimeoutMs=0, int RetryMs=0)
Writes either all Data to the given file descriptor, or nothing at all.
Definition tools.c:90
time_t LastModifiedTime(const char *FileName)
Definition tools.c:739
uint Utf8CharGet(const char *s, int Length=0)
Returns the UTF-8 symbol at the beginning of the given string.
Definition tools.c:841
char * compactspace(char *s)
Definition tools.c:239
int sgn(T a)
Definition tools.h:68
double atod(const char *s)
Converts the given string, which is a floating point number using a '.
Definition tools.c:419
cString ShortDateString(time_t t)
Converts the given time to a string of the form "dd.mm.yy".
Definition tools.c:1292
ssize_t safe_read(int filedes, void *buffer, size_t size)
Definition tools.c:53
void Poke13(uchar *p, uint16_t v)
Definition tools.h:298
bool StrInArray(const char *a[], const char *s)
Returns true if the string s is equal to one of the strings pointed to by the (NULL terminated) array...
Definition tools.c:398
char * skipspace(const char *s)
Definition tools.h:244
char * stripspace(char *s)
Definition tools.c:227
void DELETENULL(T *&p)
Definition tools.h:49
int FreeDiskSpaceMB(const char *Directory, int *UsedMB=NULL)
Definition tools.c:472
bool DoubleEqual(double a, double b)
Definition tools.h:97
ssize_t safe_write(int filedes, const void *buffer, size_t size)
Definition tools.c:65
int numdigits(int n)
Definition tools.c:362
int Utf8SymChars(const char *s, int Symbols)
Returns the number of character bytes at the beginning of the given string that form at most the give...
Definition tools.c:890
cString DayDateTime(time_t t=0)
Converts the given time to a string of the form "www dd.mm. hh:mm".
Definition tools.c:1260
int CompareStringsIgnoreCase(const void *a, const void *b)
Definition tools.h:827
bool RemoveFileOrDir(const char *FileName, bool FollowSymlinks=false)
Definition tools.c:535
int DirSizeMB(const char *DirName)
returns the total size of the files in the given directory, or -1 in case of an error
Definition tools.c:647
cString DateString(time_t t)
Converts the given time to a string of the form "www dd.mm.yyyy".
Definition tools.c:1281
cString dtoa(double d, const char *Format="%f")
Converts the given double value to a string, making sure it uses a '.
Definition tools.c:440
bool DirectoryOk(const char *DirName, bool LogErrors=false)
Definition tools.c:489
T min(T a, T b)
Definition tools.h:63
void swap(T &a, T &b)
Definition tools.h:65
int Utf8CharLen(const char *s)
Returns the number of character bytes at the beginning of the given string that form a UTF-8 symbol.
Definition tools.c:827
T max(T a, T b)
Definition tools.h:64
void syslog_with_tid(int priority, const char *format,...) __attribute__((format(printf
#define esyslog(a...)
Definition tools.h:35
off_t FileSize(const char *FileName)
returns the size of the given file, or -1 in case of an error (e.g. if the file doesn't exist)
Definition tools.c:747
int CompareStringsNumerically(const void *a, const void *b)
Definition tools.h:832
bool EntriesOnSameFileSystem(const char *File1, const char *File2)
Checks whether the given files are on the same file system.
Definition tools.c:457
char * strn0cpy(char *dest, const char *src, size_t n)
Definition tools.c:131
void put_unaligned(unsigned int v, T *p)
Definition tools.h:88
int Utf8FromArray(const uint *a, char *s, int Size, int Max=-1)
Converts the given array of UTF-8 symbols (including the terminating 0) into a sequence of character ...
Definition tools.c:956
int BCD2INT(int x)
Definition tools.c:45
bool endswith(const char *s, const char *p)
Definition tools.c:346
cString itoa(int n)
Definition tools.c:450
const char * strchrn(const char *s, char c, size_t n)
returns a pointer to the n'th occurrence (counting from 1) of c in s, or NULL if no such character wa...
Definition tools.c:186
bool isnumber(const char *s)
Definition tools.c:372
cString AddDirectory(const char *DirName, const char *FileName)
Definition tools.c:410
void writechar(int filedes, char c)
Definition tools.c:85
int64_t StrToNum(const char *s)
Converts the given string to a number.
Definition tools.c:383