trunk/src/helper.h

/***************************************************************************
 *                                                                         *
 *   libgig - C++ cross-platform Gigasampler format file access library    *
 *                                                                         *
 *   Copyright (C) 2003-2024 by Christian Schoenebeck                      *
 *                              <cuse@users.sourceforge.net>               *
 *                                                                         *
 *   This library is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this library; if not, write to the Free Software           *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 ***************************************************************************/

#ifndef __LIBGIG_HELPER_H__
#define __LIBGIG_HELPER_H__

#include <string.h>
#include <string>
#include <sstream>
#include <algorithm>
#include <assert.h>

#if defined(WIN32) && !HAVE_CONFIG_H && !defined(_MSC_VER)
# include "../win32/libgig_private.h" // like config.h, automatically generated by Dev-C++
# define PACKAGE "libgig"
# define VERSION VER_STRING // VER_STRING defined in libgig_private.h
#endif // WIN32

#if (HAVE_CONFIG_H /*&& !HAVE_VASPRINTF*/ && defined(WIN32)) || defined(_MSC_VER)
# include <stdarg.h>
int vasprintf(char** ret, const char* format, va_list arg);
#endif

#include "RIFF.h"

// *************** Helper Functions **************
// *

template<class T> inline std::string ToString(T o) {
    std::stringstream ss;
    ss << o;
    return ss.str();
}

// Behaves as printf() just that it returns it as string instead of writing to stdout.
inline std::string strPrint(const char* fmt, ...) {
    va_list args;
    va_start(args, fmt);
    char* buf = NULL;
    const int n = vasprintf(&buf, fmt, args);
    assert(n >= 0);
    std::string res = (buf && n > 0) ? buf : "";
    if (buf) free(buf);
    va_end(args);
    return res;
}

inline std::string toLowerCase(std::string s) {
    std::transform(s.begin(), s.end(), s.begin(), ::tolower);
    return s;
}

inline long Min(long A, long B) {
    return (A > B) ? B : A;
}

inline long Abs(long val) {
    return (val > 0) ? val : -val;
}

inline void swapBytes_16(void* Word) {
    uint8_t byteCache = *((uint8_t*) Word);
    *((uint8_t*) Word)     = *((uint8_t*) Word + 1);
    *((uint8_t*) Word + 1) = byteCache;
}

inline void swapBytes_32(void* Word) {
    uint8_t byteCache = *((uint8_t*) Word);
    *((uint8_t*) Word)     = *((uint8_t*) Word + 3);
    *((uint8_t*) Word + 3) = byteCache;
    byteCache = *((uint8_t*) Word + 1);
    *((uint8_t*) Word + 1) = *((uint8_t*) Word + 2);
    *((uint8_t*) Word + 2) = byteCache;
}

inline void swapBytes_64(void* Word) {
    uint8_t byteCache = ((uint8_t*)Word)[0];
    ((uint8_t*)Word)[0] = ((uint8_t*)Word)[7];
    ((uint8_t*)Word)[7] = byteCache;
    byteCache = ((uint8_t*)Word)[1];
    ((uint8_t*)Word)[1] = ((uint8_t*)Word)[6];
    ((uint8_t*)Word)[6] = byteCache;
    byteCache = ((uint8_t*)Word)[2];
    ((uint8_t*)Word)[2] = ((uint8_t*)Word)[5];
    ((uint8_t*)Word)[5] = byteCache;
    byteCache = ((uint8_t*)Word)[3];
    ((uint8_t*)Word)[3] = ((uint8_t*)Word)[4];
    ((uint8_t*)Word)[4] = byteCache;
}

inline void swapBytes(void* Word, uint64_t WordSize) {
    uint8_t byteCache;
    uint64_t lo = 0, hi = WordSize - 1;
    for (; lo < hi; hi--, lo++) {
        byteCache = *((uint8_t*) Word + lo);
        *((uint8_t*) Word + lo) = *((uint8_t*) Word + hi);
        *((uint8_t*) Word + hi) = byteCache;
    }
}

/**
 * Stores a 16 bit integer in memory using little-endian format.
 *
 * @param pData - memory pointer
 * @param data  - integer to be stored
 */
inline void store16(uint8_t* pData, uint16_t data) {
    pData[0] = data;
    pData[1] = data >> 8;
}

/**
 * Stores a 32 bit integer in memory using little-endian format.
 *
 * @param pData - memory pointer
 * @param data  - integer to be stored
 */
inline void store32(uint8_t* pData, uint32_t data) {
    pData[0] = data;
    pData[1] = data >> 8;
    pData[2] = data >> 16;
    pData[3] = data >> 24;
}

/**
 * Stores a 64 bit integer in memory using little-endian format.
 *
 * @param pData - memory pointer
 * @param data  - integer to be stored
 */
inline void store64(uint8_t* pData, uint64_t data) {
    pData[0] = data;
    pData[1] = data >> 8;
    pData[2] = data >> 16;
    pData[3] = data >> 24;
    pData[4] = data >> 32;
    pData[5] = data >> 40;
    pData[6] = data >> 48;
    pData[7] = data >> 56;
}

/**
 * Loads a 16 bit integer in memory using little-endian format.
 *
 * @param pData - memory pointer
 * @returns 16 bit data word
 */
inline uint16_t load16(uint8_t* pData) {
    return uint16_t(pData[0]) |
           uint16_t(pData[1]) << 8;
}

/**
 * Loads a 32 bit integer in memory using little-endian format.
 *
 * @param pData - memory pointer
 * @returns 32 bit data word
 */
inline uint32_t load32(uint8_t* pData) {
    return uint32_t(pData[0])       |
           uint32_t(pData[1]) << 8  |
           uint32_t(pData[2]) << 16 |
           uint32_t(pData[3]) << 24;
}

/**
 * Swaps the order of the data words in the given memory area
 * with a granularity given by \a WordSize.
 *
 * @param pData    - pointer to the memory area to be swapped
 * @param AreaSize - size of the memory area to be swapped (in bytes)
 * @param WordSize - size of the data words (in bytes)
 */
inline void SwapMemoryArea(void* pData, unsigned long AreaSize, uint WordSize) {
    if (!AreaSize) return; // AreaSize==0 would cause a segfault here
    switch (WordSize) { // TODO: unefficient
        case 1: {
            uint8_t* pDst = (uint8_t*) pData;
            uint8_t  cache;
            unsigned long lo = 0, hi = AreaSize - 1;
            for (; lo < hi; hi--, lo++) {
                cache    = pDst[lo];
                pDst[lo] = pDst[hi];
                pDst[hi] = cache;
            }
            break;
        }
        case 2: {
            uint16_t* pDst = (uint16_t*) pData;
            uint16_t  cache;
            unsigned long lo = 0, hi = (AreaSize >> 1) - 1;
            for (; lo < hi; hi--, lo++) {
                cache    = pDst[lo];
                pDst[lo] = pDst[hi];
                pDst[hi] = cache;
            }
            break;
        }
        case 4: {
            uint32_t* pDst = (uint32_t*) pData;
            uint32_t  cache;
            unsigned long lo = 0, hi = (AreaSize >> 2) - 1;
            for (; lo < hi; hi--, lo++) {
                cache    = pDst[lo];
                pDst[lo] = pDst[hi];
                pDst[hi] = cache;
            }
            break;
        }
        default: {
            uint8_t* pCache = new uint8_t[WordSize]; // TODO: unefficient
            unsigned long lo = 0, hi = AreaSize - WordSize;
            for (; lo < hi; hi -= WordSize, lo += WordSize) {
                memcpy(pCache, (uint8_t*) pData + lo, WordSize);
                memcpy((uint8_t*) pData + lo, (uint8_t*) pData + hi, WordSize);
                memcpy((uint8_t*) pData + hi, pCache, WordSize);
            }
            if (pCache) delete[] pCache;
            break;
        }
    }
}

/** @brief Load given info field (string).
 *
 * Load info field string from given info chunk (\a ck) and save value to \a s.
 */
inline void LoadString(RIFF::Chunk* ck, std::string& s) {
    if (ck) {
        const char* str = (char*)ck->LoadChunkData();
        if (!str) {
            ck->ReleaseChunkData();
            s = "";
            return;
        }
        int size = (int) ck->GetSize();
        int len;
        for (len = 0 ; len < size ; len++)
            if (str[len] == '\0') break;
        s.assign(str, len);
        ck->ReleaseChunkData();
    }
}

/** @brief Apply given INFO field to the respective chunk.
 *
 * Apply given info value string to given info chunk, which is a
 * subchunk of INFO list chunk \a lstINFO. If the given chunk already
 * exists, value \a s will be applied. Otherwise if it doesn't exist yet
 * and either \a s or \a sDefault is not an empty string, such a chunk
 * will be created and either \a s or \a sDefault will be applied
 * (depending on which one is not an empty string, if both are not an
 * empty string \a s will be preferred).
 *
 * @param ChunkID  - 32 bit RIFF chunk ID of INFO subchunk (only used in case \a ck is NULL)
 * @param ck       - INFO (sub)chunk where string should be stored to
 * @param lstINFO  - parent (INFO) RIFF list chunk
 * @param s        - current value of info field
 * @param sDefault - default value
 * @param bUseFixedLengthStrings - should a specific string size be forced in the chunk?
 * @param size     - wanted size of the INFO chunk. This is ignored if bUseFixedLengthStrings is false.
 */
inline void SaveString(uint32_t ChunkID, RIFF::Chunk* ck, RIFF::List* lstINFO, const std::string& s, const std::string& sDefault, bool bUseFixedLengthStrings, int size) {
    if (ck) { // if chunk exists already, use 's' as value
        if (!bUseFixedLengthStrings) size = (int) s.size() + 1;
        ck->Resize(size);
        char* pData = (char*) ck->LoadChunkData();
        strncpy(pData, s.c_str(), size);
    } else if (s != "" || sDefault != "" || bUseFixedLengthStrings) { // create chunk
        const std::string& sToSave = (s != "") ? s : sDefault;
        if (!bUseFixedLengthStrings) size = (int) sToSave.size() + 1;
        ck = lstINFO->AddSubChunk(ChunkID, size);
        char* pData = (char*) ck->LoadChunkData();
        strncpy(pData, sToSave.c_str(), size);
    }
}

// private helper function to convert progress of a subprocess into the global progress
inline void __notify_progress(RIFF::progress_t* pProgress, float subprogress) {
    if (pProgress && pProgress->callback) {
        const float totalrange    = pProgress->__range_max - pProgress->__range_min;
        const float totalprogress = pProgress->__range_min + subprogress * totalrange;
        pProgress->factor         = totalprogress;
        pProgress->callback(pProgress); // now actually notify about the progress
    }
}

// private helper function to divide a progress into subprogresses
inline void __divide_progress(RIFF::progress_t* pParentProgress, RIFF::progress_t* pSubProgress, float totalTasks, float currentTask) {
    if (pParentProgress && pParentProgress->callback) {
        const float totalrange    = pParentProgress->__range_max - pParentProgress->__range_min;
        pSubProgress->callback    = pParentProgress->callback;
        pSubProgress->custom      = pParentProgress->custom;
        pSubProgress->__range_min = pParentProgress->__range_min + totalrange * currentTask / totalTasks;
        pSubProgress->__range_max = pSubProgress->__range_min + totalrange / totalTasks;
    }
}

// private helper function to divide a progress into subprogresses
inline void __divide_progress(RIFF::progress_t* pParentProgress, RIFF::progress_t* pSubProgress, float total, float lo, float hi) {
    if (pParentProgress && pParentProgress->callback) {
        const float totalrange    = pParentProgress->__range_max - pParentProgress->__range_min;
        pSubProgress->callback    = pParentProgress->callback;
        pSubProgress->custom      = pParentProgress->custom;
        pSubProgress->__range_min = pParentProgress->__range_min + totalrange * (lo / total);
        pSubProgress->__range_max = pSubProgress->__range_min + totalrange * ((hi-lo) / total);
    }
}


/*****************************************************************************
 * Any problems with any of the following helper functions?                  *
 *                                                                           *
 * Then please first have a look at their current TEST CASES at              *
 * src/testcases/HelperTest.cpp as basis for your modifications!             *
 *****************************************************************************/


/// Removes one or more consecutive occurences of @a needle from the end of @a haystack.
inline std::string strip2ndFromEndOf1st(const std::string haystack, char needle) {
    if (haystack.empty()) return haystack;
    if (*haystack.rbegin() != needle) return haystack;
    for (int i = haystack.length() - 1; i >= 0; --i)
        if (haystack[i] != needle)
            return haystack.substr(0, i+1);
    return "";
}

#ifndef NATIVE_PATH_SEPARATOR
# ifdef _WIN32
#  define NATIVE_PATH_SEPARATOR '\\'
# else
#  define NATIVE_PATH_SEPARATOR '/'
# endif
#endif

/**
 * Returns the owning path of the given path (its parent path). So for example
 * passing "/some/path" would return "/some".
 */
inline std::string parentPath(const std::string path) {
    if (path.empty()) return path;
    std::string s = strip2ndFromEndOf1st(path, NATIVE_PATH_SEPARATOR);
    if (s.empty()) {
        s.push_back(NATIVE_PATH_SEPARATOR); // i.e. return "/"
        return s;
    }
    #if defined(_WIN32)
    if (s.length() == 2 && s[1] == ':')
        return s;
    #endif
    std::size_t pos = s.find_last_of(NATIVE_PATH_SEPARATOR);
    if (pos == std::string::npos) return "";
    if (pos == 0) {
        s = "";
        s.push_back(NATIVE_PATH_SEPARATOR); // i.e. return "/"
        return s;
    }
    return s.substr(0, pos);
}

/**
 * Returns the last (lowest) portion of the given path. So for example passing
 * "/some/path" would return "path".
 */
inline std::string lastPathComponent(const std::string path) {
    #if defined(_WIN32)
    if (path.length() == 2 && path[1] == ':')
        return "";
    #endif
    std::size_t pos = path.find_last_of(NATIVE_PATH_SEPARATOR);
    return (pos == std::string::npos) ? path : path.substr(pos+1);
}

/**
 * Returns the given path with the type extension being stripped from its end.
 * So for example passing "/some/path.foo" would return "/some/path".
 */
inline std::string pathWithoutExtension(const std::string path) {
    std::size_t posSep = path.find_last_of(NATIVE_PATH_SEPARATOR);
    std::size_t posBase = (posSep == std::string::npos) ? 0 : posSep+1;
    std::size_t posDot = path.find_last_of(".");
    return (posDot != std::string::npos && posDot > posBase)
           ? path.substr(0, posDot) : path;
}

/**
 * Returns the type extension of the given path. So for example passing
 * "/some/path.foo" would return "foo".
 */
inline std::string extensionOfPath(const std::string path) {
    std::size_t posSep = path.find_last_of(NATIVE_PATH_SEPARATOR);
    std::size_t posBase = (posSep == std::string::npos) ? 0 : posSep+1;
    std::size_t posDot = path.find_last_of(".");
    return (posDot != std::string::npos && posDot > posBase)
           ? path.substr(posDot+1) : "";
}

/**
 * Combines the two given paths with each other. So for example passing
 * "/some/path" and "/another/one" would return "/some/path/another/one".
 */
inline std::string concatPath(const std::string path1, const std::string path2) {
    return (!path1.empty() && *(path1.rbegin()) != NATIVE_PATH_SEPARATOR &&
            !path2.empty() && *(path2.begin())  != NATIVE_PATH_SEPARATOR)
        ? path1 + NATIVE_PATH_SEPARATOR + path2
        : path1 + path2;
}

/**
 * Returns a hex string representation of the binary data being passed.
 */
inline std::string binToHexStr(const void* pData, size_t sz) {
    std::string s;
    for (size_t i = 0; i < sz; ++i) {
        s += strPrint("%02x", ((const char*)pData)[i]);
    }
    return s;
}

#endif // __LIBGIG_HELPER_H__
1	/***************************************************************************
2	* *
3	* libgig - C++ cross-platform Gigasampler format file access library *
4	* *
5	* Copyright (C) 2003-2024 by Christian Schoenebeck *
6	* <cuse@users.sourceforge.net> *
7	* *
8	* This library is free software; you can redistribute it and/or modify *
9	* it under the terms of the GNU General Public License as published by *
10	* the Free Software Foundation; either version 2 of the License, or *
11	* (at your option) any later version. *
12	* *
13	* This library is distributed in the hope that it will be useful, *
14	* but WITHOUT ANY WARRANTY; without even the implied warranty of *
15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16	* GNU General Public License for more details. *
17	* *
18	* You should have received a copy of the GNU General Public License *
19	* along with this library; if not, write to the Free Software *
20	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21	* MA 02111-1307 USA *
22	***************************************************************************/
23
24	#ifndef __LIBGIG_HELPER_H__
25	#define __LIBGIG_HELPER_H__
26
27	#include <string.h>
28	#include <string>
29	#include <sstream>
30	#include <algorithm>
31	#include <assert.h>
32
33	#if defined(WIN32) && !HAVE_CONFIG_H && !defined(_MSC_VER)
34	# include "../win32/libgig_private.h" // like config.h, automatically generated by Dev-C++
35	# define PACKAGE "libgig"
36	# define VERSION VER_STRING // VER_STRING defined in libgig_private.h
37	#endif // WIN32
38
39	#if (HAVE_CONFIG_H /&& !HAVE_VASPRINTF/ && defined(WIN32)) \|\| defined(_MSC_VER)
40	# include <stdarg.h>
41	int vasprintf(char** ret, const char* format, va_list arg);
42	#endif
43
44	#include "RIFF.h"
45
46	// ************* Helper Functions ************
47	// *
48
49	template<class T> inline std::string ToString(T o) {
50	std::stringstream ss;
51	ss << o;
52	return ss.str();
53	}
54
55	// Behaves as printf() just that it returns it as string instead of writing to stdout.
56	inline std::string strPrint(const char* fmt, ...) {
57	va_list args;
58	va_start(args, fmt);
59	char* buf = NULL;
60	const int n = vasprintf(&buf, fmt, args);
61	assert(n >= 0);
62	std::string res = (buf && n > 0) ? buf : "";
63	if (buf) free(buf);
64	va_end(args);
65	return res;
66	}
67
68	inline std::string toLowerCase(std::string s) {
69	std::transform(s.begin(), s.end(), s.begin(), ::tolower);
70	return s;
71	}
72
73	inline long Min(long A, long B) {
74	return (A > B) ? B : A;
75	}
76
77	inline long Abs(long val) {
78	return (val > 0) ? val : -val;
79	}
80
81	inline void swapBytes_16(void* Word) {
82	uint8_t byteCache = ((uint8_t) Word);
83	((uint8_t) Word) = ((uint8_t) Word + 1);
84	((uint8_t) Word + 1) = byteCache;
85	}
86
87	inline void swapBytes_32(void* Word) {
88	uint8_t byteCache = ((uint8_t) Word);
89	((uint8_t) Word) = ((uint8_t) Word + 3);
90	((uint8_t) Word + 3) = byteCache;
91	byteCache = ((uint8_t) Word + 1);
92	((uint8_t) Word + 1) = ((uint8_t) Word + 2);
93	((uint8_t) Word + 2) = byteCache;
94	}
95
96	inline void swapBytes_64(void* Word) {
97	uint8_t byteCache = ((uint8_t*)Word)[0];
98	((uint8_t)Word)[0] = ((uint8_t)Word)[7];
99	((uint8_t*)Word)[7] = byteCache;
100	byteCache = ((uint8_t*)Word)[1];
101	((uint8_t)Word)[1] = ((uint8_t)Word)[6];
102	((uint8_t*)Word)[6] = byteCache;
103	byteCache = ((uint8_t*)Word)[2];
104	((uint8_t)Word)[2] = ((uint8_t)Word)[5];
105	((uint8_t*)Word)[5] = byteCache;
106	byteCache = ((uint8_t*)Word)[3];
107	((uint8_t)Word)[3] = ((uint8_t)Word)[4];
108	((uint8_t*)Word)[4] = byteCache;
109	}
110
111	inline void swapBytes(void* Word, uint64_t WordSize) {
112	uint8_t byteCache;
113	uint64_t lo = 0, hi = WordSize - 1;
114	for (; lo < hi; hi--, lo++) {
115	byteCache = ((uint8_t) Word + lo);
116	((uint8_t) Word + lo) = ((uint8_t) Word + hi);
117	((uint8_t) Word + hi) = byteCache;
118	}
119	}
120
121	/**
122	* Stores a 16 bit integer in memory using little-endian format.
123	*
124	* @param pData - memory pointer
125	* @param data - integer to be stored
126	*/
127	inline void store16(uint8_t* pData, uint16_t data) {
128	pData[0] = data;
129	pData[1] = data >> 8;
130	}
131
132	/**
133	* Stores a 32 bit integer in memory using little-endian format.
134	*
135	* @param pData - memory pointer
136	* @param data - integer to be stored
137	*/
138	inline void store32(uint8_t* pData, uint32_t data) {
139	pData[0] = data;
140	pData[1] = data >> 8;
141	pData[2] = data >> 16;
142	pData[3] = data >> 24;
143	}
144
145	/**
146	* Stores a 64 bit integer in memory using little-endian format.
147	*
148	* @param pData - memory pointer
149	* @param data - integer to be stored
150	*/
151	inline void store64(uint8_t* pData, uint64_t data) {
152	pData[0] = data;
153	pData[1] = data >> 8;
154	pData[2] = data >> 16;
155	pData[3] = data >> 24;
156	pData[4] = data >> 32;
157	pData[5] = data >> 40;
158	pData[6] = data >> 48;
159	pData[7] = data >> 56;
160	}
161
162	/**
163	* Loads a 16 bit integer in memory using little-endian format.
164	*
165	* @param pData - memory pointer
166	* @returns 16 bit data word
167	*/
168	inline uint16_t load16(uint8_t* pData) {
169	return uint16_t(pData[0]) \|
170	uint16_t(pData[1]) << 8;
171	}
172
173	/**
174	* Loads a 32 bit integer in memory using little-endian format.
175	*
176	* @param pData - memory pointer
177	* @returns 32 bit data word
178	*/
179	inline uint32_t load32(uint8_t* pData) {
180	return uint32_t(pData[0]) \|
181	uint32_t(pData[1]) << 8 \|
182	uint32_t(pData[2]) << 16 \|
183	uint32_t(pData[3]) << 24;
184	}
185
186	/**
187	* Swaps the order of the data words in the given memory area
188	* with a granularity given by \a WordSize.
189	*
190	* @param pData - pointer to the memory area to be swapped
191	* @param AreaSize - size of the memory area to be swapped (in bytes)
192	* @param WordSize - size of the data words (in bytes)
193	*/
194	inline void SwapMemoryArea(void* pData, unsigned long AreaSize, uint WordSize) {
195	if (!AreaSize) return; // AreaSize==0 would cause a segfault here
196	switch (WordSize) { // TODO: unefficient
197	case 1: {
198	uint8_t* pDst = (uint8_t*) pData;
199	uint8_t cache;
200	unsigned long lo = 0, hi = AreaSize - 1;
201	for (; lo < hi; hi--, lo++) {
202	cache = pDst[lo];
203	pDst[lo] = pDst[hi];
204	pDst[hi] = cache;
205	}
206	break;
207	}
208	case 2: {
209	uint16_t* pDst = (uint16_t*) pData;
210	uint16_t cache;
211	unsigned long lo = 0, hi = (AreaSize >> 1) - 1;
212	for (; lo < hi; hi--, lo++) {
213	cache = pDst[lo];
214	pDst[lo] = pDst[hi];
215	pDst[hi] = cache;
216	}
217	break;
218	}
219	case 4: {
220	uint32_t* pDst = (uint32_t*) pData;
221	uint32_t cache;
222	unsigned long lo = 0, hi = (AreaSize >> 2) - 1;
223	for (; lo < hi; hi--, lo++) {
224	cache = pDst[lo];
225	pDst[lo] = pDst[hi];
226	pDst[hi] = cache;
227	}
228	break;
229	}
230	default: {
231	uint8_t* pCache = new uint8_t[WordSize]; // TODO: unefficient
232	unsigned long lo = 0, hi = AreaSize - WordSize;
233	for (; lo < hi; hi -= WordSize, lo += WordSize) {
234	memcpy(pCache, (uint8_t*) pData + lo, WordSize);
235	memcpy((uint8_t) pData + lo, (uint8_t) pData + hi, WordSize);
236	memcpy((uint8_t*) pData + hi, pCache, WordSize);
237	}
238	if (pCache) delete[] pCache;
239	break;
240	}
241	}
242	}
243
244	/** @brief Load given info field (string).
245	*
246	* Load info field string from given info chunk (\a ck) and save value to \a s.
247	*/
248	inline void LoadString(RIFF::Chunk* ck, std::string& s) {
249	if (ck) {
250	const char* str = (char*)ck->LoadChunkData();
251	if (!str) {
252	ck->ReleaseChunkData();
253	s = "";
254	return;
255	}
256	int size = (int) ck->GetSize();
257	int len;
258	for (len = 0 ; len < size ; len++)
259	if (str[len] == '\0') break;
260	s.assign(str, len);
261	ck->ReleaseChunkData();
262	}
263	}
264
265	/** @brief Apply given INFO field to the respective chunk.
266	*
267	* Apply given info value string to given info chunk, which is a
268	* subchunk of INFO list chunk \a lstINFO. If the given chunk already
269	* exists, value \a s will be applied. Otherwise if it doesn't exist yet
270	* and either \a s or \a sDefault is not an empty string, such a chunk
271	* will be created and either \a s or \a sDefault will be applied
272	* (depending on which one is not an empty string, if both are not an
273	* empty string \a s will be preferred).
274	*
275	* @param ChunkID - 32 bit RIFF chunk ID of INFO subchunk (only used in case \a ck is NULL)
276	* @param ck - INFO (sub)chunk where string should be stored to
277	* @param lstINFO - parent (INFO) RIFF list chunk
278	* @param s - current value of info field
279	* @param sDefault - default value
280	* @param bUseFixedLengthStrings - should a specific string size be forced in the chunk?
281	* @param size - wanted size of the INFO chunk. This is ignored if bUseFixedLengthStrings is false.
282	*/
283	inline void SaveString(uint32_t ChunkID, RIFF::Chunk* ck, RIFF::List* lstINFO, const std::string& s, const std::string& sDefault, bool bUseFixedLengthStrings, int size) {
284	if (ck) { // if chunk exists already, use 's' as value
285	if (!bUseFixedLengthStrings) size = (int) s.size() + 1;
286	ck->Resize(size);
287	char* pData = (char*) ck->LoadChunkData();
288	strncpy(pData, s.c_str(), size);
289	} else if (s != "" \|\| sDefault != "" \|\| bUseFixedLengthStrings) { // create chunk
290	const std::string& sToSave = (s != "") ? s : sDefault;
291	if (!bUseFixedLengthStrings) size = (int) sToSave.size() + 1;
292	ck = lstINFO->AddSubChunk(ChunkID, size);
293	char* pData = (char*) ck->LoadChunkData();
294	strncpy(pData, sToSave.c_str(), size);
295	}
296	}
297
298	// private helper function to convert progress of a subprocess into the global progress
299	inline void __notify_progress(RIFF::progress_t* pProgress, float subprogress) {
300	if (pProgress && pProgress->callback) {
301	const float totalrange = pProgress->__range_max - pProgress->__range_min;
302	const float totalprogress = pProgress->__range_min + subprogress * totalrange;
303	pProgress->factor = totalprogress;
304	pProgress->callback(pProgress); // now actually notify about the progress
305	}
306	}
307
308	// private helper function to divide a progress into subprogresses
309	inline void __divide_progress(RIFF::progress_t* pParentProgress, RIFF::progress_t* pSubProgress, float totalTasks, float currentTask) {
310	if (pParentProgress && pParentProgress->callback) {
311	const float totalrange = pParentProgress->__range_max - pParentProgress->__range_min;
312	pSubProgress->callback = pParentProgress->callback;
313	pSubProgress->custom = pParentProgress->custom;
314	pSubProgress->__range_min = pParentProgress->__range_min + totalrange * currentTask / totalTasks;
315	pSubProgress->__range_max = pSubProgress->__range_min + totalrange / totalTasks;
316	}
317	}
318
319	// private helper function to divide a progress into subprogresses
320	inline void __divide_progress(RIFF::progress_t* pParentProgress, RIFF::progress_t* pSubProgress, float total, float lo, float hi) {
321	if (pParentProgress && pParentProgress->callback) {
322	const float totalrange = pParentProgress->__range_max - pParentProgress->__range_min;
323	pSubProgress->callback = pParentProgress->callback;
324	pSubProgress->custom = pParentProgress->custom;
325	pSubProgress->__range_min = pParentProgress->__range_min + totalrange * (lo / total);
326	pSubProgress->__range_max = pSubProgress->__range_min + totalrange * ((hi-lo) / total);
327	}
328	}
329
330
331	/*****************************************************************************
332	* Any problems with any of the following helper functions? *
333	* *
334	* Then please first have a look at their current TEST CASES at *
335	* src/testcases/HelperTest.cpp as basis for your modifications! *
336	*****************************************************************************/
337
338
339	/// Removes one or more consecutive occurences of @a needle from the end of @a haystack.
340	inline std::string strip2ndFromEndOf1st(const std::string haystack, char needle) {
341	if (haystack.empty()) return haystack;
342	if (*haystack.rbegin() != needle) return haystack;
343	for (int i = haystack.length() - 1; i >= 0; --i)
344	if (haystack[i] != needle)
345	return haystack.substr(0, i+1);
346	return "";
347	}
348
349	#ifndef NATIVE_PATH_SEPARATOR
350	# ifdef _WIN32
351	# define NATIVE_PATH_SEPARATOR '\\'
352	# else
353	# define NATIVE_PATH_SEPARATOR '/'
354	# endif
355	#endif
356
357	/**
358	* Returns the owning path of the given path (its parent path). So for example
359	* passing "/some/path" would return "/some".
360	*/
361	inline std::string parentPath(const std::string path) {
362	if (path.empty()) return path;
363	std::string s = strip2ndFromEndOf1st(path, NATIVE_PATH_SEPARATOR);
364	if (s.empty()) {
365	s.push_back(NATIVE_PATH_SEPARATOR); // i.e. return "/"
366	return s;
367	}
368	#if defined(_WIN32)
369	if (s.length() == 2 && s[1] == ':')
370	return s;
371	#endif
372	std::size_t pos = s.find_last_of(NATIVE_PATH_SEPARATOR);
373	if (pos == std::string::npos) return "";
374	if (pos == 0) {
375	s = "";
376	s.push_back(NATIVE_PATH_SEPARATOR); // i.e. return "/"
377	return s;
378	}
379	return s.substr(0, pos);
380	}
381
382	/**
383	* Returns the last (lowest) portion of the given path. So for example passing
384	* "/some/path" would return "path".
385	*/
386	inline std::string lastPathComponent(const std::string path) {
387	#if defined(_WIN32)
388	if (path.length() == 2 && path[1] == ':')
389	return "";
390	#endif
391	std::size_t pos = path.find_last_of(NATIVE_PATH_SEPARATOR);
392	return (pos == std::string::npos) ? path : path.substr(pos+1);
393	}
394
395	/**
396	* Returns the given path with the type extension being stripped from its end.
397	* So for example passing "/some/path.foo" would return "/some/path".
398	*/
399	inline std::string pathWithoutExtension(const std::string path) {
400	std::size_t posSep = path.find_last_of(NATIVE_PATH_SEPARATOR);
401	std::size_t posBase = (posSep == std::string::npos) ? 0 : posSep+1;
402	std::size_t posDot = path.find_last_of(".");
403	return (posDot != std::string::npos && posDot > posBase)
404	? path.substr(0, posDot) : path;
405	}
406
407	/**
408	* Returns the type extension of the given path. So for example passing
409	* "/some/path.foo" would return "foo".
410	*/
411	inline std::string extensionOfPath(const std::string path) {
412	std::size_t posSep = path.find_last_of(NATIVE_PATH_SEPARATOR);
413	std::size_t posBase = (posSep == std::string::npos) ? 0 : posSep+1;
414	std::size_t posDot = path.find_last_of(".");
415	return (posDot != std::string::npos && posDot > posBase)
416	? path.substr(posDot+1) : "";
417	}
418
419	/**
420	* Combines the two given paths with each other. So for example passing
421	* "/some/path" and "/another/one" would return "/some/path/another/one".
422	*/
423	inline std::string concatPath(const std::string path1, const std::string path2) {
424	return (!path1.empty() && *(path1.rbegin()) != NATIVE_PATH_SEPARATOR &&
425	!path2.empty() && *(path2.begin()) != NATIVE_PATH_SEPARATOR)
426	? path1 + NATIVE_PATH_SEPARATOR + path2
427	: path1 + path2;
428	}
429
430	/**
431	* Returns a hex string representation of the binary data being passed.
432	*/
433	inline std::string binToHexStr(const void* pData, size_t sz) {
434	std::string s;
435	for (size_t i = 0; i < sz; ++i) {
436	s += strPrint("%02x", ((const char*)pData)[i]);
437	}
438	return s;
439	}
440
441	#endif // __LIBGIG_HELPER_H__