gcc/m2/mc-boot/GM2Dependent.h

   1 /* do not edit automatically generated by mc from M2Dependent.  */
   2 /* M2Dependent.def defines the run time module dependencies interface.
   3
   4 Copyright (C) 2022-2025 Free Software Foundation, Inc.
   5 Contributed by Gaius Mulley <gaius.mulley@southwales.ac.uk>.
   6
   7 This file is part of GNU Modula-2.
   8
   9 GNU Modula-2 is free software; you can redistribute it and/or modify
  10 it under the terms of the GNU General Public License as published by
  11 the Free Software Foundation; either version 3, or (at your option)
  12 any later version.
  13
  14 GNU Modula-2 is distributed in the hope that it will be useful, but
  15 WITHOUT ANY WARRANTY; without even the implied warranty of
  16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 General Public License for more details.
  18
  19 Under Section 7 of GPL version 3, you are granted additional
  20 permissions described in the GCC Runtime Library Exception, version
  21 3.1, as published by the Free Software Foundation.
  22
  23 You should have received a copy of the GNU General Public License and
  24 a copy of the GCC Runtime Library Exception along with this program;
  25 see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  26 <http://www.gnu.org/licenses/>.  */
  27
  28
  29 #if !defined (_M2Dependent_H)
  30 #   define _M2Dependent_H
  31
  32 #include "config.h"
  33 #include "system.h"
  34 #   ifdef __cplusplus
  35 extern "C" {
  36 #   endif
  37 #include <stdbool.h>
  38 #   if !defined (PROC_D)
  39 #      define PROC_D
  40        typedef void (*PROC_t) (void);
  41        typedef struct { PROC_t proc; } PROC;
  42 #   endif
  43
  44 #   include "GSYSTEM.h"
  45
  46 #   if defined (_M2Dependent_C)
  47 #      define EXTERN
  48 #   else
  49 #      define EXTERN extern
  50 #   endif
  51
  52 typedef struct M2Dependent_ArgCVEnvP_p M2Dependent_ArgCVEnvP;
  53
  54 typedef void (*M2Dependent_ArgCVEnvP_t) (int, void *, void *);
  55 struct M2Dependent_ArgCVEnvP_p { M2Dependent_ArgCVEnvP_t proc; };
  56
  57 EXTERN void M2Dependent_ConstructModules (void * applicationmodule, void * libname, void * overrideliborder, int argc, void * argv, void * envp);
  58 EXTERN void M2Dependent_DeconstructModules (void * applicationmodule, void * libname, int argc, void * argv, void * envp);
  59
  60 /*
  61    RegisterModule - adds module name to the list of outstanding
  62                     modules which need to have their dependencies
  63                     explored to determine initialization order.
  64 */
  65
  66 EXTERN void M2Dependent_RegisterModule (void * modulename, void * libname, M2Dependent_ArgCVEnvP init, M2Dependent_ArgCVEnvP fini, PROC dependencies);
  67
  68 /*
  69    RequestDependant - used to specify that modulename:libname
  70                       is dependant upon
  71                       module dependantmodule:dependantlibname
  72 */
  73
  74 EXTERN void M2Dependent_RequestDependant (void * modulename, void * libname, void * dependantmodule, void * dependantlibname);
  75
  76 /*
  77    InstallTerminationProcedure - installs a procedure, p, which will
  78                                  be called when the procedure
  79                                  ExecuteTerminationProcedures
  80                                  is invoked.  It returns TRUE is the
  81                                  procedure is installed.
  82 */
  83
  84 EXTERN bool M2Dependent_InstallTerminationProcedure (PROC p);
  85
  86 /*
  87    ExecuteInitialProcedures - executes the initial procedures installed
  88                               by InstallInitialProcedure.
  89 */
  90
  91 EXTERN void M2Dependent_ExecuteInitialProcedures (void);
  92
  93 /*
  94    InstallInitialProcedure - installs a procedure to be executed just
  95                              before the BEGIN code section of the main
  96                              program module.
  97 */
  98
  99 EXTERN bool M2Dependent_InstallInitialProcedure (PROC p);
 100
 101 /*
 102    ExecuteTerminationProcedures - calls each installed termination procedure
 103                                   in reverse order.
 104 */
 105
 106 EXTERN void M2Dependent_ExecuteTerminationProcedures (void);
 107 #   ifdef __cplusplus
 108 }
 109 #   endif
 110
 111 #   undef EXTERN
 112 #endif