File: README

package info (click to toggle)
librepfunc 1.10.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 424 kB
  • sloc: cpp: 1,601; makefile: 270
file content (145 lines) | stat: -rw-r--r-- 4,701 bytes parent folder | download
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
This is librepfunc - a collection of functions, classes and so on,
which i use often.


Written by:                  Winfried Koehler <nvdec A.T. quantentunnel D.O.T. de >
Project's homepage:          https://github.com/wirbel-at-vdr-portal/librepfunc
Latest version available at: see homepage
License:                     GPL v2


This library is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2 as
published by the Free Software Foundation.
See the file COPYING for more information.

--------------------------------------------------------------------------------



--------------------------------------------------------------------------------
- About this library                                                           -
--------------------------------------------------------------------------------
This is a collection is utilities and functions, which i personally use in my
projects, shifting them into a lib helps me not reinvent the wheel every time.

string related:
* LowerCase and UpperCase
* LeftTrim and RightTrim and Trim
* FrontFill and BackFill
* ReplaceAll

vector of string related:
* SplitStr

number conversion to string or vice versa
 * IntToStr
 * FloatToStr
 * ExpToStr
 * StrToInt
 + StrToFloat

print time
 * TimeStr

other conversions
 * BCDtoDecimal

sleep threads
 * Sleep, mSleep, uSleep

print hex data
 * HexDump

files and directories
 * FileExists
 * cFileList
 * ReadFileToStream
 * ReadFile
 * WriteStreamToFile
 * WriteFile

start/stop threads from main thread
 * ThreadBase

(..)


--------------------------------------------------------------------------------
- About Library Versioning                                                     -
--------------------------------------------------------------------------------
This library uses a three number version numbering, following to what i under-
stand as "reasonable versioning rules".
The rule of thumb is here:

    version = MAJOR.MINOR.PATCH

example: 1.0.0


MAJOR increased -> an API-incompatible change was introduced. Installing the lib
                   may break installed packages using the old lib.

MINOR increased -> an API-compatible, new functionality was added. It's safe to
                   replace any older version of this lib with a newer one.

PATCH increased -> the API is untouched. An inprovement or bug fix was done. It
                   is recommended to replace older libs with same MAJOR.MINOR.

--------------------------------------------------------------------------------
- Library Compat                                                               -
--------------------------------------------------------------------------------
  - 1.0.0 first version, for VDR wirbelscan-Plugin 2021.10.xx, LFS parser,
          Sat Table Generator for wirbelscan.

  - 1.1.0 adds ExpToStr() for w_scan_cpp > 20211009, which in turn uses the
          VDR wirbelscan-Plugin above.

  - 1.1.1 merge pull request "Create relative symbolic links for shared library"
          to improve ubuntu build system compat

  - 1.1.2 add 'make dll' target to support mingw64 from msys2.
          This allows to use the lib on WIN32.

--------------------------------------------------------------------------------
- Library Compat                                                               -
--------------------------------------------------------------------------------
Installation:
   make -j8
   sudo make install

If you - by mistake - installed this lib and may want to completely remove it
from your system:
   sudo make uninstall

NOTE: this will remove exactly the files and links this package installed,
      not those from newer or older versions.
      However, this may break links overwritten by 'make install' of any other
      version of this lib.


Library update:
  Find the very last installed source of this lib and execute 'make uninstall'.
  Continue with Installation Process of the newer lib.

It's possible to build a static version of librepfunc (librepfunc.a):
   make -j8 librepfunc.a
   sudo make install-static


--------------------------------------------------------------------------------
- mingw64 on WIN32                                                             -
--------------------------------------------------------------------------------
Installation (in mingw64 window):
   make dll

After that, you copy the dll and header to their destinations. Suggestion for
a possible 'make install-dll' target where to put the dll and header are welcome.

Linking to the lib is done by adding
   -l:librepfunc.dll 
to your programs Makefile.


have phun,
Winfried