Mercurial > repo
diff interps/cfunge/cfunge-src/src/vector.h @ 996:859f9b4339e6
<Gregor> tar xf egobot.tar.xz
author | HackBot |
---|---|
date | Sun, 09 Dec 2012 19:30:08 +0000 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/interps/cfunge/cfunge-src/src/vector.h Sun Dec 09 19:30:08 2012 +0000 @@ -0,0 +1,52 @@ +/* -*- mode: C; coding: utf-8; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- + * + * cfunge - A standard-conforming Befunge93/98/109 interpreter in C. + * Copyright (C) 2008-2009 Arvid Norlander <anmaster AT tele2 DOT se> + * + * 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 the proxy's option) any later version. Arvid Norlander is a + * proxy who can decide which future versions of the GNU General Public + * License can be used. + * + * 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/>. + */ +/** + * @file + * Definition of, and functions for, a Funge vector. + */ +#ifndef FUNGE_HAD_SRC_VECTOR_H +#define FUNGE_HAD_SRC_VECTOR_H + +#include "global.h" + +#include <stdbool.h> + +/// A vector in Funge-Space +typedef struct s_funge_vector { + funge_cell x; ///< You should be able to guess what this is. + funge_cell y; ///< You should be able to guess what this is. +} funge_vector; + +/// Useful to create a vector in a list of parameter for example. +/// The vector is created on the stack. +/// @param a This should be the x value. +/// @param b This should be the y value. +/// @return A pointer to a vector allocated on the stack, so no need to free it. +#define vector_create_ref(a, b) (& (funge_vector) { .x = (a), .y = (b) }) + +/** + * Checks if vector is cardinal (as in ^>v<). + * @param v The vector to check. + */ +FUNGE_ATTR_PURE FUNGE_ATTR_FAST FUNGE_ATTR_WARN_UNUSED +bool vector_is_cardinal(const funge_vector * restrict v); + +#endif