Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
More ruby cleanups: stop defining everything static, and prefix functions with rb_...
[simgrid.git] / src / bindings / ruby_bindings.h
1 /* SimGrid -- Ruby bindings */
2
3 /* Copyright (c) 2010, the SimGrid team. All right reserved */
4
5 /* This program is free software; you can redistribute it and/or modify it
6  * under the terms of the license (GNU LGPL) which comes with this package. */
7
8
9 #ifndef RB_SG_BINDINGS
10 #define RB_SG_BINDINGS
11 /*
12  * There is 4 sections in this file:
13  *  - Header loading (ruby makes it quite difficult, damn it)
14  *  - definitions of ruby contextes for use in simix
15  *  - Functions to Manage The Ruby Process  (named Up Calls)
16  *  - Functions to Manage The Native Process Simulation Bound (named Down Calls)
17  */
18
19 #include "msg/msg.h"
20 #include "msg/datatypes.h"
21
22 #include "msg/mailbox.h" /* MAX_ALIAS_NAME (FIXME: kill it)*/
23 #include "surf/surfxml_parse.h"
24 #include "simix/simix.h"
25 #include "simix/private.h"
26 #include "xbt/sysdep.h"
27 #include "xbt/log.h"
28 #include "xbt/asserts.h"
29 //#include "rb_msg_host.h"
30
31 /* Damn Ruby. They load their full config.h, which breaks since we also load ours.
32  * So, we undef the offending defines
33  */
34 #undef PACKAGE_VERSION
35 #undef PACKAGE_NAME
36 #undef PACKAGE_TARNAME
37 #undef PACKAGE_STRING
38 #undef PACKAGE_BUGREPORT
39 #undef _GNU_SOURCE
40 #include <ruby.h>
41
42
43
44 /* ********************* *
45  * Context related stuff *
46  * ********************* */
47 typedef struct s_smx_ctx_ruby {
48   SMX_CTX_BASE_T;
49   VALUE process;   // The  Ruby Process Instance
50   //...
51 }s_smx_ctx_ruby_t,*smx_ctx_ruby_t;
52 void SIMIX_ctx_ruby_factory_init(smx_context_factory_t *factory);
53
54
55 void initRuby(void); // Mandatory to call Ruby methods from C
56
57 /* *********************************************** *
58  * Functions for Ruby Process Management (Up Call) *
59  *                                                 *
60  * Independent Methods                             *
61  * *********************************************** */
62
63 VALUE rb_process_getName( VALUE ruby_process );
64 VALUE rb_process_getID(VALUE ruby_process);
65 VALUE rb_process_getBind(VALUE ruby_class);
66 void  rb_process_setBind(VALUE ruby_class,long bind);
67 VALUE rb_process_isAlive(VALUE ruby_process);
68 void  rb_process_kill_up(VALUE ruby_process);
69 void  rb_process_join( VALUE ruby_process );
70 void  rb_process_unschedule( VALUE ruby_process );
71 void  rb_process_schedule( VALUE ruby_process );
72
73
74 /* ********************************************** *
75  * Function for Native Process (Bound) Management *
76  *                                                *
77  * Methods Belonging to The MSG Module            *
78  * ********************************************** */
79
80 // ProcessBind Method ; Process Ruby >> Process C
81
82 //friend Method // Not belong to the Class but Called within !!
83 m_process_t rb_process_to_native(VALUE ruby_process);
84 // Binding Process >> Friend Method
85 void rb_process_bind(VALUE ruby_class,m_process_t process);
86 void rb_process_create(VALUE Class,VALUE rb_process,VALUE host);
87 void rb_process_suspend(VALUE Class,VALUE ruby_process);
88 void rb_process_resume(VALUE Class,VALUE ruby_process);
89 // Returns Boolean ( Qtrue / Qfalse )
90 VALUE rb_process_isSuspended(VALUE Class,VALUE ruby_process);
91 void rb_process_kill_down(VALUE Class,VALUE ruby_process);
92 VALUE rb_process_getHost(VALUE Class,VALUE ruby_process);
93 void rb_process_exit(VALUE Class,VALUE ruby_process);
94
95 /* Functions related to hosts */
96 void  rb_host_free(m_host_t ht);
97 VALUE rb_host_get_by_name(VALUE Class, VALUE name);
98 VALUE rb_host_name(VALUE Class,VALUE host);
99 VALUE rb_host_number(VALUE Class);
100 VALUE rb_host_speed(VALUE Class,VALUE host);
101 void  rb_host_set_data(VALUE Class,VALUE host,VALUE data);
102 VALUE rb_host_get_data(VALUE Class,VALUE host);
103 VALUE rb_host_is_avail(VALUE Class,VALUE host);
104
105
106 #endif /* RB_SG_BINDINGS */