source: branches/branch-1-0/include/helpers/xstring.h

Last change on this file was 258, checked in by umoeller, 22 years ago

Sources as of 1.0.2 release.
  • Property svn:eol-style set to CRLF
  • Property svn:keywords set to Author Date Id Revision
File size: 10.9 KB
RevLine 
[7]1
2/*
3 *@@sourcefile xstring.h:
4 * header file for xstring.c. See notes there.
5 *
6 * Note: Version numbering in this file relates to XWorkplace version
7 * numbering.
8 *
9 *@@include #define INCL_DOSDATETIME
10 *@@include #include <os2.h>
[113]11 *@@include #include "helpers\xstring.h"
[7]12 */
13
14/*
15 * Copyright (C) 1999-2000 Ulrich M”ller.
[14]16 * This file is part of the "XWorkplace helpers" source package.
17 * This is free software; you can redistribute it and/or modify
[7]18 * it under the terms of the GNU General Public License as published
19 * by the Free Software Foundation, in version 2 as it comes in the
20 * "COPYING" file of the XWorkplace main distribution.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
25 */
26
27#if __cplusplus
28extern "C" {
29#endif
30
31#ifndef XSTRING_HEADER_INCLUDED
32 #define XSTRING_HEADER_INCLUDED
33
[14]34 #ifndef XWPENTRY
35 #error You must define XWPENTRY to contain the standard linkage for the XWPHelpers.
36 #endif
37
[7]38 /*
[12]39 *@@ XSTRING:
40 *
41 *@@added V0.9.6 (2000-11-01) [umoeller]
[7]42 */
43
[12]44 typedef struct _XSTRING
45 {
46 PSZ psz; // ptr to string or NULL
47 ULONG ulLength; // length of *psz
48 ULONG cbAllocated; // memory allocated in *psz
49 // (>= ulLength + 1)
[45]50 ULONG ulDelta; // allocation delta (0 = none)
51 // V0.9.9 (2001-03-07) [umoeller]
[91]52
53 // if memory debugging is enabled, enable the following
54 // extra fields globally... even if the caller doesn't
55 // want the replacement calls, the xstr* implementations
56 // are compiled with these fields, so they must always be
57 // present V0.9.14 (2001-08-01) [umoeller]
58 #if defined(__XWPMEMDEBUG__) // setup.h only
59 const char *file;
60 unsigned long line;
61 const char *function;
62 #endif
63
[12]64 } XSTRING, *PXSTRING;
[7]65
[91]66 #if defined(__DEBUG_MALLOC_ENABLED__) && !defined(DONT_REPLACE_XSTR_MALLOC) // setup.h, helpers\memdebug.c
67 #define xstrInit(a, b) xstrInitDebug((a), (b), __FILE__, __LINE__, __FUNCTION__)
68 void XWPENTRY xstrInitDebug(PXSTRING pxstr,
69 ULONG ulPreAllocate,
70 const char *file,
71 unsigned long line,
72 const char *function);
73 typedef void XWPENTRY XSTRINITDEBUG(PXSTRING pxstr,
74 ULONG ulPreAllocate,
75 const char *file,
76 unsigned long line,
77 const char *function);
78 typedef XSTRINITDEBUG *PXSTRINITDEBUG;
79 #else
80 void XWPENTRY xstrInit(PXSTRING pxstr, ULONG ulPreAllocate);
81 typedef void XWPENTRY XSTRINIT(PXSTRING pxstr, ULONG ulPreAllocate);
82 typedef XSTRINIT *PXSTRINIT;
83 #endif
84
85 /* void XWPENTRY xstrInit(PXSTRING pxstr, ULONG ulPreAllocate);
[14]86 typedef void XWPENTRY XSTRINIT(PXSTRING pxstr, ULONG ulPreAllocate);
[91]87 typedef XSTRINIT *PXSTRINIT; */
[12]88
[132]89 void xstrInitSet2(PXSTRING pxstr, PSZ pszNew, ULONG ulNewLength);
90
[14]91 void XWPENTRY xstrInitSet(PXSTRING pxstr, PSZ pszNew);
[15]92 typedef void XWPENTRY XSTRINITSET(PXSTRING pxstr, PSZ pszNew);
93 typedef XSTRINITSET *PXSTRINITSET;
[12]94
[129]95 #if defined(__DEBUG_MALLOC_ENABLED__) && !defined(DONT_REPLACE_XSTR_MALLOC) // setup.h, helpers\memdebug.c
96 #define xstrInitCopy(a, b, c) xstrInitCopyDebug((a), (b), (c), __FILE__, __LINE__, __FUNCTION__)
97 void XWPENTRY xstrInitCopyDebug(PXSTRING pxstr,
98 const char *pcszSource,
99 ULONG ulExtraAllocate,
100 const char *file,
101 unsigned long line,
102 const char *function);
103 typedef void XWPENTRY XSTRINITCOPYDEBUG(PXSTRING pxstr,
104 const char *pcszSource,
105 ULONG ulExtraAllocate,
106 const char *file,
107 unsigned long line,
108 const char *function);
109 typedef XSTRINITCOPYDEBUG *PXSTRINITCOPYDEBUG;
110 #else
111 void XWPENTRY xstrInitCopy(PXSTRING pxstr, const char *pcszSource, ULONG ulExtraAllocate);
112 typedef void XWPENTRY XSTRINITCOPY(PXSTRING pxstr, const char *pcszSource, ULONG ulExtraAllocate);
113 typedef XSTRINITCOPY *PXSTRINITCOPY;
114 #endif
[12]115
[14]116 void XWPENTRY xstrClear(PXSTRING pxstr);
117 typedef void XWPENTRY XSTRCLEAR(PXSTRING pxstr);
118 typedef XSTRCLEAR *PXSTRCLEAR;
[12]119
[21]120 ULONG XWPENTRY xstrReserve(PXSTRING pxstr, ULONG ulBytes);
121 typedef ULONG XWPENTRY XSTRRESERVE(PXSTRING pxstr, ULONG ulBytes);
122 typedef XSTRRESERVE *PXSTRRESERVE;
123
[108]124 void XWPENTRY xstrShrink(PXSTRING pxstr);
125 typedef void XWPENTRY XSTRSHRINK(PXSTRING pxstr);
126 typedef XSTRSHRINK *PXSTRSHRINK;
127
[14]128 PXSTRING XWPENTRY xstrCreate(ULONG ulPreAllocate);
[15]129 typedef PXSTRING XWPENTRY XSTRCREATE(ULONG ulPreAllocate);
130 typedef XSTRCREATE *PXSTRCREATE;
[12]131
[74]132 VOID XWPENTRY xstrFree(PXSTRING *ppxstr);
133 typedef VOID XWPENTRY XSTRFREE(PXSTRING *ppxstr);
[15]134 typedef XSTRFREE *PXSTRFREE;
[12]135
[132]136 ULONG XWPENTRY xstrset2(PXSTRING pxstr, PSZ pszNew, ULONG ulNewLength);
137
[14]138 ULONG XWPENTRY xstrset(PXSTRING pxstr, PSZ pszNew);
[15]139 typedef ULONG XWPENTRY XSTRSET(PXSTRING pxstr, PSZ pszNew);
140 typedef XSTRSET *PXSTRSET;
[12]141
[23]142 ULONG XWPENTRY xstrcpy(PXSTRING pxstr, const char *pcszSource, ULONG ulSourceLength);
143 typedef ULONG XWPENTRY XSTRCPY(PXSTRING pxstr, const char *pcszSource, ULONG ulSourceLength);
[15]144 typedef XSTRCPY *PXSTRCPY;
[12]145
[38]146 ULONG XWPENTRY xstrcpys(PXSTRING pxstr, const XSTRING *pcstrSource);
147 typedef ULONG XWPENTRY XSTRCPYS(PXSTRING pxstr, const XSTRING *pcstrSource);
148 typedef XSTRCPYS *PXSTRCPYS;
149
[23]150 ULONG XWPENTRY xstrcat(PXSTRING pxstr, const char *pcszSource, ULONG ulSourceLength);
151 typedef ULONG XWPENTRY XSTRCAT(PXSTRING pxstr, const char *pcszSource, ULONG ulSourceLength);
[14]152 typedef XSTRCAT *PXSTRCAT;
[12]153
[15]154 ULONG XWPENTRY xstrcatc(PXSTRING pxstr, CHAR c);
155 typedef ULONG XWPENTRY XSTRCATC(PXSTRING pxstr, CHAR c);
156 typedef XSTRCATC *PXSTRCATC;
157
[38]158 ULONG XWPENTRY xstrcats(PXSTRING pxstr, const XSTRING *pcstrSource);
159 typedef ULONG XWPENTRY XSTRCATS(PXSTRING pxstr, const XSTRING *pcstrSource);
160 typedef XSTRCATS *PXSTRCATS;
161
[7]162 /*
163 *@@ xstrIsString:
164 * returns TRUE if psz contains something.
165 *
166 *@@added V0.9.6 (2000-10-16) [umoeller]
167 */
168
169 #define xstrIsString(psz) ( (psz != 0) && (*(psz) != 0) )
170
[23]171 ULONG XWPENTRY xstrrpl(PXSTRING pxstr,
172 ULONG ulFirstReplOfs,
173 ULONG cReplLen,
[64]174 const char *pcszReplaceWith,
175 ULONG cReplaceWithLen);
[23]176 typedef ULONG XWPENTRY XSTRRPL(PXSTRING pxstr,
177 ULONG ulFirstReplOfs,
178 ULONG cReplLen,
[64]179 const char *pcszReplaceWith,
180 ULONG cReplaceWithLen);
[23]181 typedef XSTRRPL *PXSTRRPL;
182
[14]183 PSZ XWPENTRY xstrFindWord(const XSTRING *pxstr,
184 ULONG ulOfs,
185 const XSTRING *pstrFind,
186 size_t *pShiftTable,
187 PBOOL pfRepeatFind,
188 const char *pcszBeginChars,
189 const char *pcszEndChars);
[15]190 typedef PSZ XWPENTRY XSTRFINDWORD(const XSTRING *pxstr,
191 ULONG ulOfs,
192 const XSTRING *pstrFind,
193 size_t *pShiftTable,
194 PBOOL pfRepeatFind,
195 const char *pcszBeginChars,
196 const char *pcszEndChars);
197 typedef XSTRFINDWORD *PXSTRFINDWORD;
[13]198
[23]199 ULONG XWPENTRY xstrFindReplace(PXSTRING pxstr,
[15]200 PULONG pulOfs,
201 const XSTRING *pstrSearch,
202 const XSTRING *pstrReplace,
203 size_t *pShiftTable,
204 PBOOL pfRepeatFind);
[23]205 typedef ULONG XWPENTRY XSTRFINDREPLACE(PXSTRING pxstr,
206 PULONG pulOfs,
207 const XSTRING *pstrSearch,
208 const XSTRING *pstrReplace,
209 size_t *pShiftTable,
210 PBOOL pfRepeatFind);
211 typedef XSTRFINDREPLACE *PXSTRFINDREPLACE;
[7]212
[23]213 ULONG XWPENTRY xstrFindReplaceC(PXSTRING pxstr,
[15]214 PULONG pulOfs,
215 const char *pcszSearch,
216 const char *pcszReplace);
[23]217 typedef ULONG XWPENTRY XSTRFINDREPLACEC(PXSTRING pxstr,
218 PULONG pulOfs,
219 const char *pcszSearch,
220 const char *pcszReplace);
221 typedef XSTRFINDREPLACEC *PXSTRFINDREPLACEC;
222
[41]223 ULONG XWPENTRY xstrEncode(PXSTRING pxstr, const char *pcszEncode);
224 typedef ULONG XWPENTRY XSTRENCODE(PXSTRING pxstr, const char *pcszEncode);
225 typedef XSTRENCODE *PXSTRENCODE;
226
[137]227 ULONG XWPENTRY xstrDecode2(PXSTRING pxstr,
228 CHAR cKey);
229
[258]230 ULONG XWPENTRY xstrEncodeASCII(PXSTRING pxstr);
231
[41]232 ULONG XWPENTRY xstrDecode(PXSTRING pxstr);
233 typedef ULONG XWPENTRY XSTRDECODE(PXSTRING pxstr);
234 typedef XSTRDECODE *PXSTRDECODE;
235
[32]236 // V0.9.9 (2001-01-29) [lafaix]: constants added
237 #define CRLF2LF TRUE
238 #define LF2CRLF FALSE
239
[23]240 VOID XWPENTRY xstrConvertLineFormat(PXSTRING pxstr, BOOL fToCFormat);
241 typedef VOID XWPENTRY XSTRCONVERTLINEFORMAT(PXSTRING pxstr, BOOL fToCFormat);
242 typedef XSTRCONVERTLINEFORMAT *PXSTRCONVERTLINEFORMAT;
243
[171]244 VOID XWPENTRY xstrPrintf(XSTRING *pstr, PCSZ pcszFormat, ...);
245 typedef VOID XWPENTRY XSTRPRINTF(XSTRING *pstr, PCSZ pcszFormat, ...);
246 typedef XSTRPRINTF *PXSTRPRINTF;
[153]247
[154]248 VOID xstrCatf(XSTRING *pstr,
249 PCSZ pcszFormat,
250 ...);
[7]251#endif
252
253#if __cplusplus
254}
255#endif
256
Note: See TracBrowser for help on using the repository browser.