src/gigedit/global.h

/*                                                         -*- c++ -*-
 * Copyright (C) 2007-2017 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>

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