gem-graph-client/include/base.h

/**
 * @file
 * base header
 *
 * This file is part of Gem-graph.
 *
 * @cond LICENSE
 * Copyright © 2021 Libre en Communs <contact@a-lec.org>
 * Copyright © 2021-2024 Adrien Bourmault <neox@a-lec.org>
 * Copyright © 2021-2024 Jean Sirmai <jean@a-lec.org>
 *
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Affero 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 Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * @endcond
 */



#pragma once
#include <assert.h>
#include <errno.h>
#include <fcntl.h>
#include <math.h>
#include <stdio.h>
#include <stdlib.h>
#include <stddef.h> /* Defines NULL. */
#include <stdbool.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <time.h>
#include <string.h>

#include <glib-2.0/glib.h>
#include <gtk-4.0/gtk/gtk.h>

// #define G_APPLICATION_DEFAULT_FLAGS 0  TODO  What was this declaration for ?


/******************************************************************************/
/*                      S P A C E    S T R U C T U R E S                      */
/******************************************************************************/

enum { X_AXIS, Y_AXIS, Z_AXIS,    N_AXIS };    //     < used by   graphics.h


/** phantom documentation used to test the functioning of doxygen */

struct arrow_t {
    uint load;  /**< load   phantom documentation */
    uint site;  /**< site   phantom documentation */
    uint x;     /**< x      phantom documentation */
    uint y;     /**< y      phantom documentation */
    uint z;     /**< z      phantom documentation */
};


/*
       If   I'm standing on Earth (or any spinning spheroid),
            looking towards its North pole.

       Then :

          X - X   =   EAST   - WEST    =   red   - cyan
          Y - Y   =   ZENITH - NADIR   =   green - magenta (fuschia)
          Z - Z   =   NORTH  - SOUTH   =   blue  - yellow
*/

#define EAST   0 // + x  red
#define WEST   1 // - x  cyan
#define ZENITH 2 // + y  green
#define NADIR  3 // - y  magenta
#define SOUTH  4 // + z  blue
#define NORTH  5 // - z  yellow