src/gigedit/global.h

/*                                                         -*- c++ -*-
 * Copyright (C) 2007-2019 Andreas Persson
 *
 * This program 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, or (at
 * your option) any later version.
 *
 * This program 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 program; see the file COPYING. If not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 */

#ifndef GIGEDIT_GLOBAL_H
#define GIGEDIT_GLOBAL_H

#if HAVE_CONFIG_H
# include <config.h>
#endif

#include <cstring>
#include <algorithm>

#ifdef GLIBMM_HEADER_FILE
# include GLIBMM_HEADER_FILE(glibmmconfig.h)
#else
# include <glibmmconfig.h>
#endif
// threads.h must be included first to be able to build with
// G_DISABLE_DEPRECATED
#if (GLIBMM_MAJOR_VERSION == 2 && GLIBMM_MINOR_VERSION == 31 && GLIBMM_MICRO_VERSION >= 2) || \
    (GLIBMM_MAJOR_VERSION == 2 && GLIBMM_MINOR_VERSION > 31) || GLIBMM_MAJOR_VERSION > 2
#include <glibmm/threads.h>
#endif

#if !defined(WIN32)
# include <unistd.h>
# include <errno.h>
#endif

#include <sstream>
#include <map>
#include <sigc++/signal.h>

#ifdef LIBGIG_HEADER_FILE
# include LIBGIG_HEADER_FILE(gig.h)
# include LIBGIG_HEADER_FILE(Serialization.h)
#else
# include <gig.h>
# include <Serialization.h>
#endif

//FIXME: for some reason AC GETTEXT check fails on the Mac cross compiler?
#ifdef GETTEXT_HEADER_FILE
# include GETTEXT_HEADER_FILE(libintl.h)
#elif (HAVE_GETTEXT || defined(__APPLE__))
# include <libintl.h>
# define _(String) gettext(String)
#else
# define _(String) String
#endif

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

#define UNICODE_RIGHT_ARROW     Glib::ustring(1, gunichar(0x2192))
#define UNICODE_LEFT_ARROW      Glib::ustring(1, gunichar(0x2190))
#define UNICODE_SHIFT_KEY_SYMBOL    Glib::ustring("\xe2\x87\xa7")
#if defined(__APPLE__)
# define UNICODE_ALT_KEY_SYMBOL     Glib::ustring("\xe2\x8c\xa5")
#else
# define UNICODE_ALT_KEY_SYMBOL     Glib::ustring("Alt")
#endif
#define UNICODE_ERASE_KEY_SYMBOL    Glib::ustring("\xe2\x8c\xab")
#define UNICODE_CTRL_KEY_SYMBOL     Glib::ustring("Ctrl")
#define UNICODE_CMD_KEY_SYMBOL      Glib::ustring(1, gunichar(0x2318))
#if defined(__APPLE__)
# define UNICODE_PRIMARY_KEY_SYMBOL     UNICODE_CMD_KEY_SYMBOL
#else
# define UNICODE_PRIMARY_KEY_SYMBOL     UNICODE_CTRL_KEY_SYMBOL
#endif

// taken from gdk/gdkkeysyms.h
// (define on demand, to avoid unnecessary dev lib package build dependency)
#ifndef GDK_KEY_Control_L
# define GDK_KEY_Control_L 0xffe3
#endif
#ifndef GDK_KEY_Control_R
# define GDK_KEY_Control_R 0xffe4
#endif
#ifndef GDK_KEY_Left
# define GDK_KEY_Left 0xff51
#endif
#ifndef GDK_KEY_Right
# define GDK_KEY_Right 0xff53
#endif
#ifndef GDK_KEY_Up
# define GDK_KEY_Up 0xff52
#endif
#ifndef GDK_KEY_Down
# define GDK_KEY_Down 0xff54
#endif

#include <glibmm/convert.h>

#define GIG_STR_ENCODING "CP1252"

static inline
Glib::ustring gig_to_utf8(const gig::String& gig_string) {
    return Glib::convert_with_fallback(gig_string, "UTF-8", GIG_STR_ENCODING, "?");
}

static inline
gig::String gig_from_utf8(const Glib::ustring& utf8_string) {
    return Glib::convert_with_fallback(utf8_string, GIG_STR_ENCODING, "UTF-8", "?");
}

inline Glib::ustring ltrim(Glib::ustring s) {
    s.erase(s.begin(), std::find_if(s.begin(), s.end(), std::not1(std::ptr_fun<int, int>(std::isspace))));
    return s;
}

inline Glib::ustring rtrim(Glib::ustring s) {
    s.erase(std::find_if(s.rbegin(), s.rend(), std::not1(std::ptr_fun<int, int>(std::isspace))).base(), s.end());
    return s;
}

inline Glib::ustring trim(Glib::ustring s) {
    return ltrim(rtrim(s));
}

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

inline static bool endsWith(const std::string& haystack, const std::string& needle, bool caseSensitive) {
    if (haystack.size() < needle.size()) return false;
    const std::string sub = haystack.substr(haystack.size() - needle.size(), needle.size());
    return (caseSensitive) ? (sub == needle) : (!strcasecmp(sub.c_str(), needle.c_str()));
}

inline int getDimensionIndex(gig::dimension_t type, gig::Region* rgn) {
    for (uint i = 0; i < rgn->Dimensions; ++i)
        if (rgn->pDimensionDefinitions[i].dimension == type)
            return i;
    return -1;
}

inline int getDimensionRegionIndex(gig::DimensionRegion* dr) {
    if (!dr) return -1;
    gig::Region* rgn = (gig::Region*)dr->GetParent();
    for (uint i = 0; i < 256; ++i)
        if (rgn->pDimensionRegions[i] == dr)
            return i;
    return -1;
}

/// Find the number of bits required to hold the specified amount of zones.
inline int zoneCountToBits(int nZones) {
    if (!nZones) return 0;
    int iFinalBits = 0;
    int zoneBits = nZones - 1;
    for (; zoneBits > 1; iFinalBits += 2, zoneBits >>= 2);
    iFinalBits += zoneBits;
    return iFinalBits;
}

/**
 * Returns the sum of all bits of all dimensions defined before the given
 * dimensions (@a type). This allows to access cases of that particular
 * dimension directly. If the supplied dimension @a type does not exist in the
 * the supplied @a region, then this function returns -1 instead!
 *
 * @param type - dimension that shall be used
 * @param rgn - parent region of that dimension
 */
inline int baseBits(gig::dimension_t type, gig::Region* rgn) {
    int previousBits = 0;
    for (uint i = 0; i < rgn->Dimensions; ++i) {
        if (rgn->pDimensionDefinitions[i].dimension == type) return previousBits;
        previousBits += rgn->pDimensionDefinitions[i].bits;
    }
    return -1;
}

// key: dimension type, value: dimension's zone index
class DimensionCase : public std::map<gig::dimension_t,int> {
public:
    bool isViolating(const DimensionCase& c) const {
        for (DimensionCase::const_iterator it = begin(); it != end(); ++it) {
            if (c.find(it->first) == c.end()) continue;
            if (c.find(it->first)->second != it->second) return true;
        }
        return false;
    }

    // prevent passing gig::dimension_none from creating a new pair
    // (TODO: other invalid gig::dimension_t values should be filtered here as well)
    int& operator[](const gig::dimension_t& k) {
        static int unused = 0;
        if (k == gig::dimension_none) {
            unused = 0;
            return unused;
        }
        return std::map<gig::dimension_t,int>::operator[](k);
    }
};

//TODO: this function and caseOfDimRegion() from dimregionchooser.h are duplicates, eliminate either one of them!
inline DimensionCase dimensionCaseOf(gig::DimensionRegion* dr) {
    DimensionCase dimCase;
    int idr = getDimensionRegionIndex(dr);
    if (idr < 0) return dimCase;
    gig::Region* rgn = (gig::Region*)dr->GetParent();
    int bitpos = 0;
    for (int d = 0; d < rgn->Dimensions; ++d) {
        const gig::dimension_def_t& dimdef = rgn->pDimensionDefinitions[d];
        const int zone = (idr >> bitpos) & ((1 << dimdef.bits) - 1);
        dimCase[dimdef.dimension] = zone;
        bitpos += rgn->pDimensionDefinitions[d].bits;
    }
    return dimCase;
}

/**
 * Checks whether the passed dimension zones are within the boundaries of the
 * defined dimensions. This is especially relevant if there are dimensions
 * defined with an amount not equal to a power of two, in that case there are
 * unused dimensions regions which should be ignored.
 */
inline bool isUsedCase(const DimensionCase& c, gig::Region* rgn) {
    for (int d = 0; d < rgn->Dimensions; ++d) {
        gig::dimension_t type = rgn->pDimensionDefinitions[d].dimension;
        if (c.find(type) == c.end()) continue;
        int zone = c.find(type)->second;
        if (zone < 0 || zone >= rgn->pDimensionDefinitions[d].zones)
            return false;
    }
    return true;
}

inline std::vector<gig::DimensionRegion*> dimensionRegionsMatching(
    const DimensionCase& dimCase, gig::Region* rgn, bool skipUnusedZones = false)
{
    std::vector<gig::DimensionRegion*> v;
    for (int idr = 0; idr < 256; ++idr) {
        if (!rgn->pDimensionRegions[idr]) continue;
        DimensionCase c = dimensionCaseOf(rgn->pDimensionRegions[idr]);
        if (dimCase.isViolating(c)) continue;
        if (skipUnusedZones && !isUsedCase(c, rgn)) continue;
        v.push_back(rgn->pDimensionRegions[idr]);
    }
    return v;
}

inline gig::DimensionRegion* dimensionRegionMatching(const DimensionCase& dimCase, gig::Region* rgn) {
    for (int idr = 0; idr < 256; ++idr) {
        if (!rgn->pDimensionRegions[idr]) continue;
        DimensionCase c = dimensionCaseOf(rgn->pDimensionRegions[idr]);
        if (c == dimCase) return rgn->pDimensionRegions[idr];
    }
    return NULL;
}

template<typename T_Message>
class SignalGuard {
public:
    SignalGuard(sigc::signal<void, T_Message>& start, sigc::signal<void, T_Message>& end, T_Message message)
        : m_end(end), m_message(message)
    {
        if (message) start.emit(message);
    }

    virtual ~SignalGuard() {
        if (m_message) m_end.emit(m_message);
    }
protected:
    sigc::signal<void, T_Message>& m_end;
    T_Message m_message;
};

#endif // GIGEDIT_GLOBAL_H
1	schoenebeck	1396	/* -- c++ --
2	persson	3462	* Copyright (C) 2007-2019 Andreas Persson
3	schoenebeck	1396	*
4			* This program is free software; you can redistribute it and/or
5			* modify it under the terms of the GNU General Public License as
6			* published by the Free Software Foundation; either version 2, or (at
7			* your option) any later version.
8			*
9			* This program is distributed in the hope that it will be useful, but
10			* WITHOUT ANY WARRANTY; without even the implied warranty of
11			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12			* General Public License for more details.
13			*
14			* You should have received a copy of the GNU General Public License
15			* along with program; see the file COPYING. If not, write to the Free
16			* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
17			* 02110-1301 USA.
18			*/
19
20			#ifndef GIGEDIT_GLOBAL_H
21			#define GIGEDIT_GLOBAL_H
22
23			#if HAVE_CONFIG_H
24			# include <config.h>
25			#endif
26
27	schoenebeck	3151	#include <cstring>
28	schoenebeck	3341	#include <algorithm>
29	schoenebeck	3151
30	schoenebeck	3364	#ifdef GLIBMM_HEADER_FILE
31			# include GLIBMM_HEADER_FILE(glibmmconfig.h)
32			#else
33			# include <glibmmconfig.h>
34			#endif
35	schoenebeck	3151	// threads.h must be included first to be able to build with
36			// G_DISABLE_DEPRECATED
37			#if (GLIBMM_MAJOR_VERSION == 2 && GLIBMM_MINOR_VERSION == 31 && GLIBMM_MICRO_VERSION >= 2) \|\| \
38			(GLIBMM_MAJOR_VERSION == 2 && GLIBMM_MINOR_VERSION > 31) \|\| GLIBMM_MAJOR_VERSION > 2
39			#include <glibmm/threads.h>
40			#endif
41
42	schoenebeck	2967	#if !defined(WIN32)
43			# include <unistd.h>
44			# include <errno.h>
45			#endif
46
47	persson	2442	#include <sstream>
48	schoenebeck	3089	#include <map>
49	persson	3462	#include <sigc++/signal.h>
50	persson	2442
51	schoenebeck	3089	#ifdef LIBGIG_HEADER_FILE
52			# include LIBGIG_HEADER_FILE(gig.h)
53	schoenebeck	3157	# include LIBGIG_HEADER_FILE(Serialization.h)
54	schoenebeck	3089	#else
55			# include <gig.h>
56	schoenebeck	3157	# include <Serialization.h>
57	schoenebeck	3089	#endif
58
59	schoenebeck	2474	//FIXME: for some reason AC GETTEXT check fails on the Mac cross compiler?
60	schoenebeck	3364	#ifdef GETTEXT_HEADER_FILE
61			# include GETTEXT_HEADER_FILE(libintl.h)
62			#elif (HAVE_GETTEXT \|\| defined(__APPLE__))
63	schoenebeck	1396	# include <libintl.h>
64			# define _(String) gettext(String)
65			#else
66			# define _(String) String
67			#endif
68
69			#if defined(WIN32) && !HAVE_CONFIG_H
70			# include "../../win32/libgigedit_private.h" // like config.h, automatically generated by Dev-C++
71			# define PACKAGE "gigedit"
72			# define VERSION VER_STRING // VER_STRING defined in libgig_private.h
73			#endif // WIN32
74
75	schoenebeck	2692	#define UNICODE_RIGHT_ARROW Glib::ustring(1, gunichar(0x2192))
76			#define UNICODE_LEFT_ARROW Glib::ustring(1, gunichar(0x2190))
77	schoenebeck	3155	#define UNICODE_SHIFT_KEY_SYMBOL Glib::ustring("\xe2\x87\xa7")
78			#if defined(__APPLE__)
79			# define UNICODE_ALT_KEY_SYMBOL Glib::ustring("\xe2\x8c\xa5")
80			#else
81			# define UNICODE_ALT_KEY_SYMBOL Glib::ustring("Alt")
82			#endif
83			#define UNICODE_ERASE_KEY_SYMBOL Glib::ustring("\xe2\x8c\xab")
84			#define UNICODE_CTRL_KEY_SYMBOL Glib::ustring("Ctrl")
85			#define UNICODE_CMD_KEY_SYMBOL Glib::ustring(1, gunichar(0x2318))
86			#if defined(__APPLE__)
87			# define UNICODE_PRIMARY_KEY_SYMBOL UNICODE_CMD_KEY_SYMBOL
88			#else
89			# define UNICODE_PRIMARY_KEY_SYMBOL UNICODE_CTRL_KEY_SYMBOL
90			#endif
91	schoenebeck	2692
92	schoenebeck	3123	// taken from gdk/gdkkeysyms.h
93			// (define on demand, to avoid unnecessary dev lib package build dependency)
94			#ifndef GDK_KEY_Control_L
95			# define GDK_KEY_Control_L 0xffe3
96			#endif
97			#ifndef GDK_KEY_Control_R
98			# define GDK_KEY_Control_R 0xffe4
99			#endif
100			#ifndef GDK_KEY_Left
101			# define GDK_KEY_Left 0xff51
102			#endif
103			#ifndef GDK_KEY_Right
104			# define GDK_KEY_Right 0xff53
105			#endif
106			#ifndef GDK_KEY_Up
107			# define GDK_KEY_Up 0xff52
108			#endif
109			#ifndef GDK_KEY_Down
110			# define GDK_KEY_Down 0xff54
111			#endif
112
113	schoenebeck	3151	#include <glibmm/convert.h>
114
115			#define GIG_STR_ENCODING "CP1252"
116
117			static inline
118			Glib::ustring gig_to_utf8(const gig::String& gig_string) {
119			return Glib::convert_with_fallback(gig_string, "UTF-8", GIG_STR_ENCODING, "?");
120			}
121
122			static inline
123			gig::String gig_from_utf8(const Glib::ustring& utf8_string) {
124			return Glib::convert_with_fallback(utf8_string, GIG_STR_ENCODING, "UTF-8", "?");
125			}
126
127	schoenebeck	3340	inline Glib::ustring ltrim(Glib::ustring s) {
128			s.erase(s.begin(), std::find_if(s.begin(), s.end(), std::not1(std::ptr_fun<int, int>(std::isspace))));
129			return s;
130			}
131
132			inline Glib::ustring rtrim(Glib::ustring s) {
133			s.erase(std::find_if(s.rbegin(), s.rend(), std::not1(std::ptr_fun<int, int>(std::isspace))).base(), s.end());
134			return s;
135			}
136
137			inline Glib::ustring trim(Glib::ustring s) {
138			return ltrim(rtrim(s));
139			}
140
141	persson	2442	template<class T> inline std::string ToString(T o) {
142			std::stringstream ss;
143			ss << o;
144			return ss.str();
145			}
146
147	schoenebeck	3176	inline static bool endsWith(const std::string& haystack, const std::string& needle, bool caseSensitive) {
148			if (haystack.size() < needle.size()) return false;
149			const std::string sub = haystack.substr(haystack.size() - needle.size(), needle.size());
150			return (caseSensitive) ? (sub == needle) : (!strcasecmp(sub.c_str(), needle.c_str()));
151			}
152
153	schoenebeck	3089	inline int getDimensionIndex(gig::dimension_t type, gig::Region* rgn) {
154			for (uint i = 0; i < rgn->Dimensions; ++i)
155			if (rgn->pDimensionDefinitions[i].dimension == type)
156			return i;
157			return -1;
158			}
159
160			inline int getDimensionRegionIndex(gig::DimensionRegion* dr) {
161			if (!dr) return -1;
162			gig::Region* rgn = (gig::Region*)dr->GetParent();
163			for (uint i = 0; i < 256; ++i)
164			if (rgn->pDimensionRegions[i] == dr)
165			return i;
166			return -1;
167			}
168
169	schoenebeck	2548	/// Find the number of bits required to hold the specified amount of zones.
170			inline int zoneCountToBits(int nZones) {
171	schoenebeck	2604	if (!nZones) return 0;
172	schoenebeck	2548	int iFinalBits = 0;
173			int zoneBits = nZones - 1;
174			for (; zoneBits > 1; iFinalBits += 2, zoneBits >>= 2);
175			iFinalBits += zoneBits;
176			return iFinalBits;
177			}
178
179	schoenebeck	3089	/**
180			* Returns the sum of all bits of all dimensions defined before the given
181			* dimensions (@a type). This allows to access cases of that particular
182			* dimension directly. If the supplied dimension @a type does not exist in the
183			* the supplied @a region, then this function returns -1 instead!
184			*
185			* @param type - dimension that shall be used
186			* @param rgn - parent region of that dimension
187			*/
188			inline int baseBits(gig::dimension_t type, gig::Region* rgn) {
189			int previousBits = 0;
190			for (uint i = 0; i < rgn->Dimensions; ++i) {
191			if (rgn->pDimensionDefinitions[i].dimension == type) return previousBits;
192			previousBits += rgn->pDimensionDefinitions[i].bits;
193			}
194			return -1;
195			}
196
197			// key: dimension type, value: dimension's zone index
198			class DimensionCase : public std::map<gig::dimension_t,int> {
199			public:
200			bool isViolating(const DimensionCase& c) const {
201			for (DimensionCase::const_iterator it = begin(); it != end(); ++it) {
202			if (c.find(it->first) == c.end()) continue;
203			if (c.find(it->first)->second != it->second) return true;
204			}
205			return false;
206			}
207	schoenebeck	3123
208			// prevent passing gig::dimension_none from creating a new pair
209			// (TODO: other invalid gig::dimension_t values should be filtered here as well)
210			int& operator[](const gig::dimension_t& k) {
211			static int unused = 0;
212			if (k == gig::dimension_none) {
213			unused = 0;
214			return unused;
215			}
216			return std::map<gig::dimension_t,int>::operator[](k);
217			}
218	schoenebeck	3089	};
219
220	schoenebeck	3123	//TODO: this function and caseOfDimRegion() from dimregionchooser.h are duplicates, eliminate either one of them!
221	schoenebeck	3089	inline DimensionCase dimensionCaseOf(gig::DimensionRegion* dr) {
222			DimensionCase dimCase;
223			int idr = getDimensionRegionIndex(dr);
224			if (idr < 0) return dimCase;
225			gig::Region* rgn = (gig::Region*)dr->GetParent();
226			int bitpos = 0;
227			for (int d = 0; d < rgn->Dimensions; ++d) {
228			const gig::dimension_def_t& dimdef = rgn->pDimensionDefinitions[d];
229			const int zone = (idr >> bitpos) & ((1 << dimdef.bits) - 1);
230			dimCase[dimdef.dimension] = zone;
231			bitpos += rgn->pDimensionDefinitions[d].bits;
232			}
233			return dimCase;
234			}
235
236	schoenebeck	3307	/**
237			* Checks whether the passed dimension zones are within the boundaries of the
238			* defined dimensions. This is especially relevant if there are dimensions
239			* defined with an amount not equal to a power of two, in that case there are
240			* unused dimensions regions which should be ignored.
241			*/
242			inline bool isUsedCase(const DimensionCase& c, gig::Region* rgn) {
243			for (int d = 0; d < rgn->Dimensions; ++d) {
244			gig::dimension_t type = rgn->pDimensionDefinitions[d].dimension;
245			if (c.find(type) == c.end()) continue;
246			int zone = c.find(type)->second;
247			if (zone < 0 \|\| zone >= rgn->pDimensionDefinitions[d].zones)
248			return false;
249			}
250			return true;
251			}
252
253			inline std::vector<gig::DimensionRegion*> dimensionRegionsMatching(
254			const DimensionCase& dimCase, gig::Region* rgn, bool skipUnusedZones = false)
255			{
256	schoenebeck	3089	std::vector<gig::DimensionRegion*> v;
257			for (int idr = 0; idr < 256; ++idr) {
258			if (!rgn->pDimensionRegions[idr]) continue;
259			DimensionCase c = dimensionCaseOf(rgn->pDimensionRegions[idr]);
260	schoenebeck	3307	if (dimCase.isViolating(c)) continue;
261			if (skipUnusedZones && !isUsedCase(c, rgn)) continue;
262			v.push_back(rgn->pDimensionRegions[idr]);
263	schoenebeck	3089	}
264			return v;
265			}
266
267	schoenebeck	3123	inline gig::DimensionRegion* dimensionRegionMatching(const DimensionCase& dimCase, gig::Region* rgn) {
268			for (int idr = 0; idr < 256; ++idr) {
269			if (!rgn->pDimensionRegions[idr]) continue;
270			DimensionCase c = dimensionCaseOf(rgn->pDimensionRegions[idr]);
271			if (c == dimCase) return rgn->pDimensionRegions[idr];
272			}
273			return NULL;
274			}
275
276	schoenebeck	3177	template<typename T_Message>
277			class SignalGuard {
278			public:
279			SignalGuard(sigc::signal<void, T_Message>& start, sigc::signal<void, T_Message>& end, T_Message message)
280			: m_end(end), m_message(message)
281			{
282			if (message) start.emit(message);
283			}
284
285			virtual ~SignalGuard() {
286			if (m_message) m_end.emit(m_message);
287			}
288			protected:
289			sigc::signal<void, T_Message>& m_end;
290			T_Message m_message;
291			};
292
293	schoenebeck	1396	#endif // GIGEDIT_GLOBAL_H