src/main.h

/*
 *  LDForge: LDraw parts authoring CAD
 *  Copyright (C) 2013, 2014 Santeri Piippo
 *
 *  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 3 of the License, 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */

// =============================================================================
// This file is included one way or another in every source file of LDForge.
// Stuff defined and included here is universally included.

#ifndef LDFORGE_MAIN_H
#define LDFORGE_MAIN_H

// Hack to make KDevelop parse QString properly. Q_REQUIRED_RESULT expands into
// an __attribute__((warn_unused_result)) KDevelop's lexer doesn't seem to
// understand, yielding an error and leaving some methods unlexed.
//
// The following first includes <QChar> to get Q_REQUIRED_RESULT defined first,
// then re-defining it as nothing. This causes Q_REQUIRED_RESULT to essentially
// "vanish" from QString's methods when KDevelop lexes them.
//
// Similar reasoning for Q_DECL_HIDDEN, except with Q_OBJECT this time.
#ifdef IN_IDE_PARSER
# include <QChar>
# undef Q_REQUIRED_RESULT
# undef Q_DECL_HIDDEN
# define Q_REQUIRED_RESULT
# define Q_DECL_HIDDEN
#endif

#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
#include <stdarg.h>
#include <QString>
#include <QTextFormat>

#include "property.h"
#include "config.h"

#define APPNAME			"LDForge"
#define UNIXNAME			"ldforge"
#define VERSION_MAJOR	0
#define VERSION_MINOR	2
#define VERSION_PATCH	999
#define BUILD_ID			BUILD_INTERNAL

#define BUILD_INTERNAL	0
#define BUILD_RELEASE	1

// =============================================
#ifdef DEBUG
# undef RELEASE
#endif // DEBUG

#ifdef RELEASE
# undef DEBUG
#endif // RELEASE

// =============================================
#define alias auto&
#define elif(A) else if (A)

// Null pointer
static const std::nullptr_t null = nullptr;

#ifdef WIN32
# define DIRSLASH "\\"
# define DIRSLASH_CHAR '\\'
#else // WIN32
# define DIRSLASH "/"
# define DIRSLASH_CHAR '/'
#endif // WIN32

#ifdef null
#undef null
#endif // null

#ifdef __GNUC__
#define FUNCNAME __PRETTY_FUNCTION__
#else
#define FUNCNAME __func__
#endif // __GNUC__

#ifdef IN_IDE_PARSER
void dlog(void, ...) {}
#else
# ifdef DEBUG
#  define dlog(...) log( str( __PRETTY_FUNCTION__ ) + ": " __VA_ARGS__)
# else
#  define dlog(...)
# endif // DEBUG
#endif // IN_IDE_PARSER

// Replace assert with a version that shows a GUI dialog if possible.
// On Windows I just can't get the actual error messages otherwise.
void assertionFailure (const char* file, int line, const char* funcname, const char* expr);

#ifdef assert
# undef assert
#endif // assert

#ifdef DEBUG
# define assert(N) { ((N) ? (void) 0 : assertionFailure (__FILE__, __LINE__, FUNCNAME, #N)); }
#else
# define assert(N) {}
#endif // DEBUG

// Version string identifier
QString versionString();
QString fullVersionString();

#define properties private
#define typedefs public
#define methods
#define for_axes(AX) for (const Axis AX : std::initializer_list<const Axis> ({X, Y, Z}))

#ifndef IN_IDE_PARSER
#define NORETURN [noreturn]
#else
#define NORETURN
#endif

// -----------------------------------------------------------------------------
#ifdef IN_IDE_PARSER // KDevelop workarounds:
# error IN_IDE_PARSER is defined (this code is only for KDevelop workarounds)

# ifndef va_start
#  define va_start(va, arg)
# endif // va_start

# ifndef va_end
#  define va_end(va)
# endif // va_end

static const char* __func__ = ""; // Current function name
typedef void FILE; // :|
#endif // IN_IDE_PARSER

#endif // LDFORGE_MAIN_H