entry.h

/***************************************************************************
 *   Copyright (C) 2011 by Terraneo Federico                               *
 *                                                                         *
 *   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 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.                          *
 *                                                                         *
 *   As a special exception, if other files instantiate templates or use   *
 *   macros or inline functions from this file, or you compile this file   *
 *   and link it with other works to produce a work based on this file,    *
 *   this file does not by itself cause the resulting work to be covered   *
 *   by the GNU General Public License. However the source code for this   *
 *   file must still be made available in accordance with the GNU General  *
 *   Public License. This exception does not invalidate any other reasons  *
 *   why a work based on this file might be covered by the GNU General     *
 *   Public License.                                                       *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, see <http://www.gnu.org/licenses/>   *
 ***************************************************************************/

#pragma once

/**
 * \file entry.h
 * This file exists only to avoid adding a couple of #ifdef in user code to
 * make it work both with Miosix and within the simulator. When compiling for
 * Miosix it includes miosix.h
 */

//
// Include miosix.h only if we are not compiling for the simulator
//
#ifdef _MIOSIX
#include "miosix.h"
#endif //_MIOSIX

/**
 * \ingroup pub_iface
 * Simple macro to work around the fact that under miosix the code starts
 * at main(), while within the mxgui simulator code starts at entryPoint()
 *
 * Use it like this:
 * \code
 * ENTRY()
 * {
 *     //Your main() code
 * }
 * \endcode
 */
#ifdef _MIOSIX
#define ENTRY int main
#else //_MIOSIX
#define ENTRY int entryPoint
#endif //_MIOSIX