gem-graph-client/include/base.h

/*  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *
*                                                                              *
*                              Gem-graph client                                *
*                                                                              *
*                                Base header                                   *
*                                                                              *
*         Copyright © 2021 Libre en Communs <contact@a-lec.org>                *
*         Copyright © 2021 Adrien Bourmault <neox@a-lec.org>                   *
*         Copyright © 2021 Arthur Menges <arthur.menges@a-lec.org>             *
*         Copyright © 2021 Jean Sirmai <jean@a-lec.org>                        *
*                                                                              *
*                        This file is part of Gem-graph.                       *
*                                                                              *
*   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/>.    *
*                                                                              *
*  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  */



#pragma once
#include <assert.h>
#include <errno.h>
#include <fcntl.h>
#include <math.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdbool.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <glib-2.0/glib.h>
#include <gtk-4.0/gtk/gtk.h>

//  #define G_APPLICATION_DEFAULT_FLAGS 0    <    work TODO here ?



/******************************************************************************/
/*                         S T A T E   M A C H I N E                          */
/******************************************************************************/

enum choice_EXEC_EDIT          { EXEC, EDIT };             //  xor
enum choice_STATE_RULES_DATA   { STATE, RULES, DATA };     //  xor

void set_EXEC_EDIT (int prescribed);
void set_STATE_RULES_DATA (int prescribed);

int  get_EXEC_EDIT ();
int  get_STATE_RULES_DATA ();



/******************************************************************************/
/*                      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

struct arrow_t { uint load; uint site; uint x; uint y; uint z; };


/*
       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


/******************************************************************************/
/*                             U T I L I T I E S                              */
/******************************************************************************/

/*
 * char *read_file(char *filename)
 *          reads a file from filename into a provided buffer
 *
 * @param   filename, file name
 *          contents, target ptr
 *
 * @return  void
 */
static inline char *read_file(char *filename)
{
    int fd;
    int filesize;
    char *contents;

    fd = open(filename, O_RDONLY);
    if(fd < 0) {
        printf("Couldn't read file: %s\n",filename);
        return NULL;
    }

    filesize = lseek(fd, 0, SEEK_END) + 1 ;
    contents = g_malloc(filesize * sizeof(char));
    assert (contents);

    lseek(fd, 0, SEEK_SET);
    read(fd,contents,filesize);

    contents[filesize-1] = '\0';

    close(fd);

    return contents;
}


/******************************************************************************/
/*                                 T E X T S                                  */
/******************************************************************************/

char *get_space_run_edit_specif();
char *get_rules_run_edit_specif();

/*  (texts are in widgets_lab)  */