apis 0.5.13

Reactive, session-oriented, asynchronous process-calculus framework
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
//! This is an interactive program example in which a graphical rendering
//! context is passed between sessions. The program cycles through three modes
//! (sessions) by pressing the 'Tab' key. These sessions are simple (they only
//! contain a single process and no channels). The transitions are defined such
//! that the rendering context is passed from the previous session to the next
//! session.
//!
//! - In 'Bgr' mode, the keys 'B', 'G', and 'R' will change the clear color.
//! - In 'Cym' mode, the keys 'C', 'Y', and 'M' will change the clear color.
//! - In 'Wsk' mode, the keys 'W', 'S', and 'K' will change the clear color.
//!
//! Note that generally this example should not generate any warnings or errors.
//!
//! Running this example will produce a DOT file representing the program state
//! transition diagram. To create a PNG image from the generated DOT file:
//!
//! ```bash
//! make -f MakefileDot graphical
//! ```

use colored;
use env_logger;
use glium;
use log;

use apis;

use glium::glutin;

////////////////////////////////////////////////////////////////////////////////
//  constants                                                                 //
////////////////////////////////////////////////////////////////////////////////

//  Off, Error, Warn, Info, Debug, Trace
pub const LOG_LEVEL : log::LevelFilter = log::LevelFilter::Info;

////////////////////////////////////////////////////////////////////////////////
//  statics                                                                   //
////////////////////////////////////////////////////////////////////////////////

pub static CONTEXT_ALIVE : std::sync::atomic::AtomicBool =
  std::sync::atomic::AtomicBool::new (false);

////////////////////////////////////////////////////////////////////////////////
//  datatypes                                                                 //
////////////////////////////////////////////////////////////////////////////////

pub struct GlutinGliumContext {
  pub event_loop   : glutin::event_loop::EventLoop <()>,
  pub glium_display : glium::Display
}

impl std::fmt::Debug for GlutinGliumContext {
  fn fmt (&self, f : &mut std::fmt::Formatter) -> std::fmt::Result {
    write!(f, "GlutinGliumContext")
  }
}

#[derive(Clone, Debug)]
#[derive(Default)]
pub enum ModeControl {
  Next,
  #[default]
  Quit
}


////////////////////////////////////////////////////////////////////////////////
//  program                                                                   //
////////////////////////////////////////////////////////////////////////////////

apis::def_program! {
  program Graphical where
    let results = session.run()
  {
    MODES [
      mode bgr::Bgr {
        use apis::Process;
        println!("results: {results:?}");
        let mode_control
          = bgr::InputRender::extract_result (&mut results).unwrap();
        match mode_control {
          ModeControl::Next => Some (EventId::ToCym),
          ModeControl::Quit => None
        }
      }
      mode cym::Cym {
        use apis::Process;
        println!("results: {results:?}");
        let mode_control
          = cym::InputRender::extract_result (&mut results).unwrap();
        match mode_control {
          ModeControl::Next => Some (EventId::ToWsk),
          ModeControl::Quit => None
        }
      }
      mode wsk::Wsk {
        use apis::Process;
        println!("results: {results:?}");
        let mode_control
          = wsk::InputRender::extract_result (&mut results).unwrap();
        match mode_control {
          ModeControl::Next => Some (EventId::ToBgr),
          ModeControl::Quit => None
        }
      }
    ]
    TRANSITIONS  [
      transition ToCym <bgr::Bgr> => <cym::Cym> [
        InputRender (bgr) => InputRender (cym) {
          cym.glutin_glium_context = bgr.glutin_glium_context.take();
        }
      ]
      transition ToWsk <cym::Cym> => <wsk::Wsk> [
        InputRender (cym) => InputRender (wsk) {
          wsk.glutin_glium_context = cym.glutin_glium_context.take();
        }
      ]
      transition ToBgr <wsk::Wsk> => <bgr::Bgr> [
        InputRender (wsk) => InputRender (bgr) {
          bgr.glutin_glium_context = wsk.glutin_glium_context.take();
        }
      ]
    ]
    initial_mode: Bgr
  }
}

////////////////////////////////////////////////////////////////////////////////
//  mode Bgr                                                                  //
////////////////////////////////////////////////////////////////////////////////

pub mod bgr {
  use {std, glium, glium::glutin};
  use apis;
  use crate::{CONTEXT_ALIVE, GlutinGliumContext, ModeControl};

  apis::def_session! {
    context Bgr {
      PROCESSES where
        let process    = self,
        let message_in = message_in
      [
        process InputRender (
          frame                : u64 = 0,
          clear_color          : (f32, f32, f32, f32) = (0.0, 0.0, 1.0, 1.0),
          glutin_glium_context : Option <GlutinGliumContext> = {
            if !CONTEXT_ALIVE.swap (true, std::sync::atomic::Ordering::SeqCst) {
              let event_loop = glutin::event_loop::EventLoop::new();
              let glium_display = glium::Display::new (
                glutin::window::WindowBuilder::new(),
                glutin::ContextBuilder::new(),
                &event_loop).unwrap();
              Some (GlutinGliumContext { event_loop, glium_display })
            } else {
              None
            }
          }
        ) -> (ModeControl) {
          kind           { apis::process::Kind::Anisochronous }
          sourcepoints   [ ]
          endpoints      [ ]
          initialize     { println!("...BGR initialize..."); }
          handle_message { unreachable!() }
          update         { process.input_render_update() }
        }
      ]
      CHANNELS [ ]
      MESSAGES [ ]
      main: InputRender
    }
  }

  impl InputRender {
    fn input_render_update (&mut self) -> apis::process::ControlFlow {
      log::trace!("input_render update...");

      log::trace!("input_render frame: {}", self.frame);

      let mut result      = apis::process::ControlFlow::Continue;
      let mut clear_color = self.clear_color;
      let mut presult = self.result.clone();
      { // glutin_glium_context scope
        use glium::Surface;
        use glutin::platform::run_return::EventLoopExtRunReturn;

        let glutin_glium_context = self.glutin_glium_context.as_mut().unwrap();

        // poll events
        glutin_glium_context.event_loop.run_return (|event, _, control_flow| {
          use glutin::event::{self, Event};
          //println!("frame[{}] event: {:?}", frame, event);
          *control_flow = glutin::event_loop::ControlFlow::Poll;
          match event {
            Event::DeviceEvent { event: event::DeviceEvent::Key (keyboard_input), .. } =>
              if keyboard_input.state == event::ElementState::Pressed {
                match keyboard_input.virtual_keycode {
                  Some (event::VirtualKeyCode::Tab) => {
                    result  = apis::process::ControlFlow::Break;
                    presult = ModeControl::Next;
                  }
                  Some (event::VirtualKeyCode::Q) => {
                    result  = apis::process::ControlFlow::Break;
                    presult = ModeControl::Quit;
                  }
                  Some (event::VirtualKeyCode::B) => {
                    clear_color = (0.0, 0.0, 1.0, 1.0);
                  }
                  Some (event::VirtualKeyCode::G) => {
                    clear_color = (0.0, 1.0, 0.0, 1.0);
                  }
                  Some (event::VirtualKeyCode::R) => {
                    clear_color = (1.0, 0.0, 0.0, 1.0);
                  }
                  _ => {}
                }
              }
            Event::MainEventsCleared =>
              *control_flow = glutin::event_loop::ControlFlow::Exit,
            _ => {}
          }
        });

        // draw frame
        let mut glium_frame
          = glutin_glium_context.glium_display.draw();
        glium_frame.clear_all (clear_color, 0.0, 0);
        glium_frame.finish().unwrap();
      } // end glutin_glium_context scope
      self.clear_color = clear_color;
      self.frame += 1;

      log::trace!("...input_render update");

      self.result = presult;
      result
    } // end fn input_render_update
  } // end impl InputRender

} // end mod bgr

////////////////////////////////////////////////////////////////////////////////
//  mode Cym                                                                  //
////////////////////////////////////////////////////////////////////////////////

pub mod cym {
  use glium::glutin;
  use apis;
  use crate::{GlutinGliumContext, ModeControl};

  apis::def_session! {
    context Cym {
      PROCESSES where
        let process    = self,
        let message_in = message_in
      [
        process InputRender (
          frame                : u64 = 0,
          clear_color          : (f32, f32, f32, f32) = (0.0, 1.0, 1.0, 1.0),
          glutin_glium_context : Option <GlutinGliumContext> = None
        ) -> (ModeControl) {
          kind           { apis::process::Kind::Anisochronous }
          sourcepoints   []
          endpoints      []
          terminate      { println!("...CYM terminate..."); }
          handle_message { unreachable!() }
          update         { process.input_render_update() }
        }
      ]
      CHANNELS [ ]
      MESSAGES [ ]
      main: InputRender
    }
  }

  impl InputRender {
    fn input_render_update (&mut self) -> apis::process::ControlFlow {
      log::trace!("input_render update...");

      log::trace!("input_render frame: {}", self.frame);

      let mut result      = apis::process::ControlFlow::Continue;
      let mut presult     = self.result.clone();
      let mut clear_color = self.clear_color;
      { // glutin_glium_context scope
        use glium::Surface;
        use glutin::platform::run_return::EventLoopExtRunReturn;

        let glutin_glium_context = self.glutin_glium_context.as_mut().unwrap();

        // poll events
        glutin_glium_context.event_loop.run_return (|event, _, control_flow| {
          use glutin::event::{self, Event};
          //println!("frame[{}] event: {:?}", frame, event);
          *control_flow = glutin::event_loop::ControlFlow::Poll;
          match event {
            Event::DeviceEvent { event: event::DeviceEvent::Key (keyboard_input), .. } =>
              if keyboard_input.state == event::ElementState::Pressed {
                match keyboard_input.virtual_keycode {
                  Some (event::VirtualKeyCode::Tab) => {
                    result  = apis::process::ControlFlow::Break;
                    presult = ModeControl::Next;
                  }
                  Some (event::VirtualKeyCode::Q) => {
                    result  = apis::process::ControlFlow::Break;
                    presult = ModeControl::Quit;
                  }
                  Some (event::VirtualKeyCode::C) => {
                    clear_color = (0.0, 1.0, 1.0, 1.0);
                  }
                  Some (event::VirtualKeyCode::Y) => {
                    clear_color = (1.0, 1.0, 0.0, 1.0);
                  }
                  Some (event::VirtualKeyCode::M) => {
                    clear_color = (1.0, 0.0, 1.0, 1.0);
                  }
                  _ => {}
                }
              }
            Event::MainEventsCleared =>
              *control_flow = glutin::event_loop::ControlFlow::Exit,
            _ => {}
          }
        });

        // draw frame
        let mut glium_frame
          = glutin_glium_context.glium_display.draw();
        glium_frame.clear_all (clear_color, 0.0, 0);
        glium_frame.finish().unwrap();
      } // end glutin_glium_context scope
      self.clear_color = clear_color;
      self.frame += 1;

      log::trace!("...input_render update");

      self.result = presult;
      result
    } // end fn input_render_update
  } // end impl InputRender
} // end mod cym

////////////////////////////////////////////////////////////////////////////////
//  mode Wsk                                                                  //
////////////////////////////////////////////////////////////////////////////////

pub mod wsk {
  use glium::glutin;
  use apis;
  use crate::{GlutinGliumContext, ModeControl};

  apis::def_session! {
    context Wsk {
      PROCESSES where
        let process    = self,
        let message_in = message_in
      [
        process InputRender (
          frame                : u64 = 0,
          clear_color          : (f32, f32, f32, f32) = (1.0, 1.0, 1.0, 1.0),
          glutin_glium_context : Option <GlutinGliumContext> = None
        ) -> (ModeControl) {
          kind           { apis::process::Kind::Anisochronous }
          sourcepoints   []
          endpoints      []
          initialize     { println!("...wsk initialize..."); }
          terminate      { println!("...wsk terminate..."); }
          handle_message { unreachable!() }
          update         { process.input_render_update() }
        }
      ]
      CHANNELS [ ]
      MESSAGES [ ]
      main: InputRender
    }
  }

  impl InputRender {
    fn input_render_update (&mut self) -> apis::process::ControlFlow {
      log::trace!("input_render update...");

      log::trace!("input_render frame: {}", self.frame);

      let mut result      = apis::process::ControlFlow::Continue;
      let mut presult     = self.result.clone();
      let mut clear_color = self.clear_color;
      { // glutin_glium_context scope
        use glium::Surface;
        use glutin::platform::run_return::EventLoopExtRunReturn;

        let glutin_glium_context = self.glutin_glium_context.as_mut().unwrap();

        // poll events
        glutin_glium_context.event_loop.run_return (|event, _, control_flow| {
          use glutin::event::{self, Event};
          //println!("frame[{}] event: {:?}", frame, event);
          *control_flow = glutin::event_loop::ControlFlow::Poll;
          match event {
            Event::DeviceEvent { event: event::DeviceEvent::Key (keyboard_input), .. } =>
              if keyboard_input.state == event::ElementState::Pressed {
                match keyboard_input.virtual_keycode {
                  Some (event::VirtualKeyCode::Tab) => {
                    result  = apis::process::ControlFlow::Break;
                    presult = ModeControl::Next;
                  }
                  Some (event::VirtualKeyCode::Q) => {
                    result  = apis::process::ControlFlow::Break;
                    presult = ModeControl::Quit;
                  }
                  Some (event::VirtualKeyCode::W) => {
                    clear_color = (1.0, 1.0, 1.0, 1.0);
                  }
                  Some (event::VirtualKeyCode::S) => {
                    clear_color = (0.5, 0.5, 0.5, 1.0);
                  }
                  Some (event::VirtualKeyCode::K) => {
                    clear_color = (0.0, 0.0, 0.0, 1.0);
                  }
                  _ => {}
                }
              }
            Event::MainEventsCleared =>
              *control_flow = glutin::event_loop::ControlFlow::Exit,
            _ => {}
          }
        });

        // draw frame
        let mut glium_frame
          = glutin_glium_context.glium_display.draw();
        glium_frame.clear_all (clear_color, 0.0, 0);
        glium_frame.finish().unwrap();
      } // end glutin_glium_context scope
      self.clear_color = clear_color;
      self.frame += 1;

      log::trace!("...input_render update");

      self.result = presult;
      result
    } // end fn input_render_update
  } // end impl InputRender
} // end mod wsk

////////////////////////////////////////////////////////////////////////////////
//  main                                                                      //
////////////////////////////////////////////////////////////////////////////////

fn main() {
  use colored::Colorize;

  let example_name = std::path::PathBuf::from (std::env::args().next().unwrap())
    .file_name().unwrap().to_str().unwrap().to_string();

  println!("{}", format!("{example_name} main...").green().bold());

  env_logger::Builder::new()
    .filter_level (LOG_LEVEL)
    .parse_default_env()
    .init();

  // create a dotfile for the program state machine
  use std::io::Write;
  let mut f = std::fs::File::create (format!("{example_name}.dot")).unwrap();
  f.write_all (Graphical::dotfile().as_bytes()).unwrap();
  drop (f);

  // report size information
  Graphical::report_sizes();

  // create a program in the initial mode
  use apis::Program;
  let mut myprogram = Graphical::initial();
  //log::debug!("myprogram: {:#?}", myprogram);
  // run to completion
  myprogram.run();

  println!("{}", format!("...{example_name} main").green().bold());
}