src/libs/Kernel.h

   1 /*
   2       This file is part of Smoothie (http://smoothieware.org/). The motion control part is heavily based on Grbl (https://github.com/simen/grbl).
   3       Smoothie is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
   4       Smoothie 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 General Public License for more details.
   5       You should have received a copy of the GNU General Public License along with Smoothie. If not, see <http://www.gnu.org/licenses/>.
   6 */
   7
   8 #ifndef KERNEL_H
   9 #define KERNEL_H
  10 #include "libs/Module.h"
  11 #include "libs/Config.h"
  12 #include "libs/SlowTicker.h"
  13 #include "modules/communication/SerialConsole.h"
  14 #include "modules/communication/GcodeDispatch.h"
  15 #include "modules/robot/Planner.h"
  16 #include "modules/robot/Robot.h"
  17 #include "modules/robot/Stepper.h"
  18 #include "mbed.h"
  19
  20 // See : http://smoothieware.org/listofevents
  21 #define NUMBER_OF_DEFINED_EVENTS   11
  22 #define ON_MAIN_LOOP               0
  23 #define ON_CONSOLE_LINE_RECEIVED   1
  24 #define ON_GCODE_RECEIVED          2
  25 #define ON_STEPPER_WAKE_UP         3    //TODO : Remove the need for this event, then this event itself eg: have planner call stepper directly
  26 #define ON_GCODE_EXECUTE           4
  27 #define ON_SPEED_CHANGE            5
  28 #define ON_BLOCK_BEGIN             6
  29 #define ON_BLOCK_END               7
  30 #define ON_CONFIG_RELOAD           8
  31 #define ON_PLAY                    9
  32 #define ON_PAUSE                   10
  33
  34
  35 using namespace std;
  36 #include <vector>
  37
  38 typedef void (Module::*ModuleCallback)(void * argument);
  39
  40 //Module manager
  41 class Module;
  42 class Player;
  43 class Kernel {
  44     public:
  45         Kernel();
  46         void add_module(Module* module);
  47         void register_for_event(unsigned int id_event, Module* module);
  48         void call_event(unsigned int id_event);
  49         void call_event(unsigned int id_event, void * argument);
  50
  51         // These modules are aviable to all other modules
  52         SerialConsole*    serial;
  53         GcodeDispatch*    gcode_dispatch;
  54         Robot*            robot;
  55         Stepper*          stepper;
  56         Planner*          planner;
  57         Config*           config;
  58         Player*           player;
  59
  60         int debug;
  61         SlowTicker* slow_ticker;
  62
  63     private:
  64         vector<Module*> hooks[NUMBER_OF_DEFINED_EVENTS]; // When a module asks to be called for a specific event ( a hook ), this is where that request is remembered
  65
  66 };
  67
  68 #endif