MRGcodeProcessor.h

Go to the documentation of this file.

#pragma once
 
#include <MRCMisc/common.h>
#include <MRCMisc/exports.h>
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct MR_CNCMachineSettings MR_CNCMachineSettings; // Defined in `#include <MRCMesh/MRCNCMachineSettings.h>`.
typedef struct MR_std_string MR_std_string; // Defined in `#include <MRCMisc/std_string.h>`.
typedef struct MR_std_vector_MR_GcodeProcessor_Command MR_std_vector_MR_GcodeProcessor_Command; // Defined in `#include <MRCMisc/std_vector_MR_GcodeProcessor_Command.h>`.
typedef struct MR_std_vector_MR_GcodeProcessor_MoveAction MR_std_vector_MR_GcodeProcessor_MoveAction; // Defined in `#include <MRCMisc/std_vector_MR_GcodeProcessor_MoveAction.h>`.
typedef struct MR_std_vector_MR_Vector2f MR_std_vector_MR_Vector2f; // Defined in `#include <MRCMisc/std_vector_MR_Vector2f.h>`.
typedef struct MR_std_vector_MR_Vector3f MR_std_vector_MR_Vector3f; // Defined in `#include <MRCMisc/std_vector_MR_Vector3f.h>`.
typedef struct MR_std_vector_std_string MR_std_vector_std_string; // Defined in `#include <MRCMisc/std_vector_std_string.h>`.
 
 
// class to process g-code source and generate toolpath
typedef struct MR_GcodeProcessor MR_GcodeProcessor;
 
typedef struct MR_GcodeProcessor_BaseAction_MR_Vector2f MR_GcodeProcessor_BaseAction_MR_Vector2f;
 
typedef struct MR_GcodeProcessor_BaseAction_MR_Vector3f MR_GcodeProcessor_BaseAction_MR_Vector3f;
 
// structure that stores information about the movement of the tool, specified by some string of commands
typedef struct MR_GcodeProcessor_MoveAction MR_GcodeProcessor_MoveAction;
 
typedef struct MR_GcodeProcessor_Command MR_GcodeProcessor_Command;
 
MRC_API MR_GcodeProcessor *MR_GcodeProcessor_DefaultConstruct(void);
 
MRC_API MR_GcodeProcessor *MR_GcodeProcessor_DefaultConstructArray(size_t num_elems);
 
MRC_API const MR_GcodeProcessor *MR_GcodeProcessor_OffsetPtr(const MR_GcodeProcessor *ptr, ptrdiff_t i);
 
MRC_API MR_GcodeProcessor *MR_GcodeProcessor_OffsetMutablePtr(MR_GcodeProcessor *ptr, ptrdiff_t i);
 
MRC_API MR_GcodeProcessor *MR_GcodeProcessor_ConstructFromAnother(MR_PassBy _other_pass_by, MR_GcodeProcessor *_other);
 
MRC_API void MR_GcodeProcessor_Destroy(const MR_GcodeProcessor *_this);
 
MRC_API void MR_GcodeProcessor_DestroyArray(const MR_GcodeProcessor *_this);
 
MRC_API MR_GcodeProcessor *MR_GcodeProcessor_AssignFromAnother(MR_GcodeProcessor *_this, MR_PassBy _other_pass_by, MR_GcodeProcessor *_other);
 
// reset internal states
MRC_API void MR_GcodeProcessor_reset(MR_GcodeProcessor *_this);
 
// set g-code source
MRC_API void MR_GcodeProcessor_setGcodeSource(MR_GcodeProcessor *_this, const MR_std_vector_std_string *gcodeSource);
 
// process all lines g-code source and generate corresponding move actions
MRC_API MR_std_vector_MR_GcodeProcessor_MoveAction *MR_GcodeProcessor_processSource(MR_GcodeProcessor *_this);
 
// process all commands from one line g-code source and generate corresponding move action;
// \param externalStorage to avoid memory allocation on each line
MRC_API MR_GcodeProcessor_MoveAction *MR_GcodeProcessor_processLine(MR_GcodeProcessor *_this, const char *line, const char *line_end, MR_std_vector_MR_GcodeProcessor_Command *externalStorage);
 
// settings
MRC_API void MR_GcodeProcessor_setCNCMachineSettings(MR_GcodeProcessor *_this, const MR_CNCMachineSettings *settings);
 
MRC_API const MR_CNCMachineSettings *MR_GcodeProcessor_getCNCMachineSettings(MR_GcodeProcessor *_this);
 
// tool movement parsed from gcode
MRC_API const MR_std_vector_MR_Vector2f *MR_GcodeProcessor_BaseAction_MR_Vector2f_Get_path(const MR_GcodeProcessor_BaseAction_MR_Vector2f *_this);
 
// tool movement parsed from gcode
MRC_API void MR_GcodeProcessor_BaseAction_MR_Vector2f_Set_path(MR_GcodeProcessor_BaseAction_MR_Vector2f *_this, MR_PassBy value_pass_by, MR_std_vector_MR_Vector2f *value);
 
// tool movement parsed from gcode
MRC_API MR_std_vector_MR_Vector2f *MR_GcodeProcessor_BaseAction_MR_Vector2f_GetMutable_path(MR_GcodeProcessor_BaseAction_MR_Vector2f *_this);
 
// parser warning
MRC_API const MR_std_string *MR_GcodeProcessor_BaseAction_MR_Vector2f_Get_warning(const MR_GcodeProcessor_BaseAction_MR_Vector2f *_this);
 
// parser warning
MRC_API void MR_GcodeProcessor_BaseAction_MR_Vector2f_Set_warning(MR_GcodeProcessor_BaseAction_MR_Vector2f *_this, const char *value, const char *value_end);
 
// parser warning
MRC_API MR_std_string *MR_GcodeProcessor_BaseAction_MR_Vector2f_GetMutable_warning(MR_GcodeProcessor_BaseAction_MR_Vector2f *_this);
 
MRC_API MR_GcodeProcessor_BaseAction_MR_Vector2f *MR_GcodeProcessor_BaseAction_MR_Vector2f_DefaultConstruct(void);
 
MRC_API MR_GcodeProcessor_BaseAction_MR_Vector2f *MR_GcodeProcessor_BaseAction_MR_Vector2f_DefaultConstructArray(size_t num_elems);
 
MRC_API MR_GcodeProcessor_BaseAction_MR_Vector2f *MR_GcodeProcessor_BaseAction_MR_Vector2f_ConstructFrom(MR_PassBy path_pass_by, MR_std_vector_MR_Vector2f *path, const char *warning, const char *warning_end);
 
MRC_API const MR_GcodeProcessor_BaseAction_MR_Vector2f *MR_GcodeProcessor_BaseAction_MR_Vector2f_OffsetPtr(const MR_GcodeProcessor_BaseAction_MR_Vector2f *ptr, ptrdiff_t i);
 
MRC_API MR_GcodeProcessor_BaseAction_MR_Vector2f *MR_GcodeProcessor_BaseAction_MR_Vector2f_OffsetMutablePtr(MR_GcodeProcessor_BaseAction_MR_Vector2f *ptr, ptrdiff_t i);
 
MRC_API MR_GcodeProcessor_BaseAction_MR_Vector2f *MR_GcodeProcessor_BaseAction_MR_Vector2f_ConstructFromAnother(MR_PassBy _other_pass_by, MR_GcodeProcessor_BaseAction_MR_Vector2f *_other);
 
MRC_API void MR_GcodeProcessor_BaseAction_MR_Vector2f_Destroy(const MR_GcodeProcessor_BaseAction_MR_Vector2f *_this);
 
MRC_API void MR_GcodeProcessor_BaseAction_MR_Vector2f_DestroyArray(const MR_GcodeProcessor_BaseAction_MR_Vector2f *_this);
 
MRC_API MR_GcodeProcessor_BaseAction_MR_Vector2f *MR_GcodeProcessor_BaseAction_MR_Vector2f_AssignFromAnother(MR_GcodeProcessor_BaseAction_MR_Vector2f *_this, MR_PassBy _other_pass_by, MR_GcodeProcessor_BaseAction_MR_Vector2f *_other);
 
// tool movement parsed from gcode
MRC_API const MR_std_vector_MR_Vector3f *MR_GcodeProcessor_BaseAction_MR_Vector3f_Get_path(const MR_GcodeProcessor_BaseAction_MR_Vector3f *_this);
 
// tool movement parsed from gcode
MRC_API void MR_GcodeProcessor_BaseAction_MR_Vector3f_Set_path(MR_GcodeProcessor_BaseAction_MR_Vector3f *_this, MR_PassBy value_pass_by, MR_std_vector_MR_Vector3f *value);
 
// tool movement parsed from gcode
MRC_API MR_std_vector_MR_Vector3f *MR_GcodeProcessor_BaseAction_MR_Vector3f_GetMutable_path(MR_GcodeProcessor_BaseAction_MR_Vector3f *_this);
 
// parser warning
MRC_API const MR_std_string *MR_GcodeProcessor_BaseAction_MR_Vector3f_Get_warning(const MR_GcodeProcessor_BaseAction_MR_Vector3f *_this);
 
// parser warning
MRC_API void MR_GcodeProcessor_BaseAction_MR_Vector3f_Set_warning(MR_GcodeProcessor_BaseAction_MR_Vector3f *_this, const char *value, const char *value_end);
 
// parser warning
MRC_API MR_std_string *MR_GcodeProcessor_BaseAction_MR_Vector3f_GetMutable_warning(MR_GcodeProcessor_BaseAction_MR_Vector3f *_this);
 
MRC_API MR_GcodeProcessor_BaseAction_MR_Vector3f *MR_GcodeProcessor_BaseAction_MR_Vector3f_DefaultConstruct(void);
 
MRC_API MR_GcodeProcessor_BaseAction_MR_Vector3f *MR_GcodeProcessor_BaseAction_MR_Vector3f_DefaultConstructArray(size_t num_elems);
 
MRC_API MR_GcodeProcessor_BaseAction_MR_Vector3f *MR_GcodeProcessor_BaseAction_MR_Vector3f_ConstructFrom(MR_PassBy path_pass_by, MR_std_vector_MR_Vector3f *path, const char *warning, const char *warning_end);
 
MRC_API const MR_GcodeProcessor_BaseAction_MR_Vector3f *MR_GcodeProcessor_BaseAction_MR_Vector3f_OffsetPtr(const MR_GcodeProcessor_BaseAction_MR_Vector3f *ptr, ptrdiff_t i);
 
MRC_API MR_GcodeProcessor_BaseAction_MR_Vector3f *MR_GcodeProcessor_BaseAction_MR_Vector3f_OffsetMutablePtr(MR_GcodeProcessor_BaseAction_MR_Vector3f *ptr, ptrdiff_t i);
 
MRC_API MR_GcodeProcessor_BaseAction_MR_Vector3f *MR_GcodeProcessor_BaseAction_MR_Vector3f_ConstructFromAnother(MR_PassBy _other_pass_by, MR_GcodeProcessor_BaseAction_MR_Vector3f *_other);
 
MRC_API void MR_GcodeProcessor_BaseAction_MR_Vector3f_Destroy(const MR_GcodeProcessor_BaseAction_MR_Vector3f *_this);
 
MRC_API void MR_GcodeProcessor_BaseAction_MR_Vector3f_DestroyArray(const MR_GcodeProcessor_BaseAction_MR_Vector3f *_this);
 
MRC_API MR_GcodeProcessor_BaseAction_MR_Vector3f *MR_GcodeProcessor_BaseAction_MR_Vector3f_AssignFromAnother(MR_GcodeProcessor_BaseAction_MR_Vector3f *_this, MR_PassBy _other_pass_by, MR_GcodeProcessor_BaseAction_MR_Vector3f *_other);
 
MRC_API const MR_GcodeProcessor_BaseAction_MR_Vector3f *MR_GcodeProcessor_MoveAction_Get_action(const MR_GcodeProcessor_MoveAction *_this);
 
MRC_API void MR_GcodeProcessor_MoveAction_Set_action(MR_GcodeProcessor_MoveAction *_this, MR_PassBy value_pass_by, MR_GcodeProcessor_BaseAction_MR_Vector3f *value);
 
MRC_API MR_GcodeProcessor_BaseAction_MR_Vector3f *MR_GcodeProcessor_MoveAction_GetMutable_action(MR_GcodeProcessor_MoveAction *_this);
 
// tool direction for each point from action.path
MRC_API const MR_std_vector_MR_Vector3f *MR_GcodeProcessor_MoveAction_Get_toolDirection(const MR_GcodeProcessor_MoveAction *_this);
 
// tool direction for each point from action.path
MRC_API void MR_GcodeProcessor_MoveAction_Set_toolDirection(MR_GcodeProcessor_MoveAction *_this, MR_PassBy value_pass_by, MR_std_vector_MR_Vector3f *value);
 
// tool direction for each point from action.path
MRC_API MR_std_vector_MR_Vector3f *MR_GcodeProcessor_MoveAction_GetMutable_toolDirection(MR_GcodeProcessor_MoveAction *_this);
 
MRC_API const bool *MR_GcodeProcessor_MoveAction_Get_idle(const MR_GcodeProcessor_MoveAction *_this);
 
MRC_API void MR_GcodeProcessor_MoveAction_Set_idle(MR_GcodeProcessor_MoveAction *_this, bool value);
 
MRC_API bool *MR_GcodeProcessor_MoveAction_GetMutable_idle(MR_GcodeProcessor_MoveAction *_this);
 
MRC_API const float *MR_GcodeProcessor_MoveAction_Get_feedrate(const MR_GcodeProcessor_MoveAction *_this);
 
MRC_API void MR_GcodeProcessor_MoveAction_Set_feedrate(MR_GcodeProcessor_MoveAction *_this, float value);
 
MRC_API float *MR_GcodeProcessor_MoveAction_GetMutable_feedrate(MR_GcodeProcessor_MoveAction *_this);
 
MRC_API MR_GcodeProcessor_MoveAction *MR_GcodeProcessor_MoveAction_DefaultConstruct(void);
 
MRC_API MR_GcodeProcessor_MoveAction *MR_GcodeProcessor_MoveAction_DefaultConstructArray(size_t num_elems);
 
MRC_API MR_GcodeProcessor_MoveAction *MR_GcodeProcessor_MoveAction_ConstructFrom(MR_PassBy action_pass_by, MR_GcodeProcessor_BaseAction_MR_Vector3f *action, MR_PassBy toolDirection_pass_by, MR_std_vector_MR_Vector3f *toolDirection, bool idle, float feedrate);
 
MRC_API const MR_GcodeProcessor_MoveAction *MR_GcodeProcessor_MoveAction_OffsetPtr(const MR_GcodeProcessor_MoveAction *ptr, ptrdiff_t i);
 
MRC_API MR_GcodeProcessor_MoveAction *MR_GcodeProcessor_MoveAction_OffsetMutablePtr(MR_GcodeProcessor_MoveAction *ptr, ptrdiff_t i);
 
MRC_API MR_GcodeProcessor_MoveAction *MR_GcodeProcessor_MoveAction_ConstructFromAnother(MR_PassBy _other_pass_by, MR_GcodeProcessor_MoveAction *_other);
 
MRC_API void MR_GcodeProcessor_MoveAction_Destroy(const MR_GcodeProcessor_MoveAction *_this);
 
MRC_API void MR_GcodeProcessor_MoveAction_DestroyArray(const MR_GcodeProcessor_MoveAction *_this);
 
MRC_API bool MR_GcodeProcessor_MoveAction_ConvertTo_bool(const MR_GcodeProcessor_MoveAction *_this);
 
MRC_API MR_GcodeProcessor_MoveAction *MR_GcodeProcessor_MoveAction_AssignFromAnother(MR_GcodeProcessor_MoveAction *_this, MR_PassBy _other_pass_by, MR_GcodeProcessor_MoveAction *_other);
 
// return true if operation was parsed without warnings
MRC_API bool MR_GcodeProcessor_MoveAction_valid(const MR_GcodeProcessor_MoveAction *_this);
 
// in lowercase
MRC_API const char *MR_GcodeProcessor_Command_Get_key(const MR_GcodeProcessor_Command *_this);
 
// in lowercase
MRC_API void MR_GcodeProcessor_Command_Set_key(MR_GcodeProcessor_Command *_this, char value);
 
// in lowercase
MRC_API char *MR_GcodeProcessor_Command_GetMutable_key(MR_GcodeProcessor_Command *_this);
 
MRC_API const float *MR_GcodeProcessor_Command_Get_value(const MR_GcodeProcessor_Command *_this);
 
MRC_API void MR_GcodeProcessor_Command_Set_value(MR_GcodeProcessor_Command *_this, float value);
 
MRC_API float *MR_GcodeProcessor_Command_GetMutable_value(MR_GcodeProcessor_Command *_this);
 
MRC_API MR_GcodeProcessor_Command *MR_GcodeProcessor_Command_DefaultConstruct(void);
 
MRC_API MR_GcodeProcessor_Command *MR_GcodeProcessor_Command_DefaultConstructArray(size_t num_elems);
 
MRC_API MR_GcodeProcessor_Command *MR_GcodeProcessor_Command_ConstructFrom(char key, float value);
 
MRC_API const MR_GcodeProcessor_Command *MR_GcodeProcessor_Command_OffsetPtr(const MR_GcodeProcessor_Command *ptr, ptrdiff_t i);
 
MRC_API MR_GcodeProcessor_Command *MR_GcodeProcessor_Command_OffsetMutablePtr(MR_GcodeProcessor_Command *ptr, ptrdiff_t i);
 
MRC_API MR_GcodeProcessor_Command *MR_GcodeProcessor_Command_ConstructFromAnother(const MR_GcodeProcessor_Command *_other);
 
MRC_API void MR_GcodeProcessor_Command_Destroy(const MR_GcodeProcessor_Command *_this);
 
MRC_API void MR_GcodeProcessor_Command_DestroyArray(const MR_GcodeProcessor_Command *_this);
 
MRC_API MR_GcodeProcessor_Command *MR_GcodeProcessor_Command_AssignFromAnother(MR_GcodeProcessor_Command *_this, const MR_GcodeProcessor_Command *_other);
 
#ifdef __cplusplus
} // extern "C"
#endif