mirror of
https://github.com/Ultimaker/Cura.git
synced 2025-07-06 22:47:29 -06:00
63bdb08ec2
It needs to be accessed by GCodeReader to remain consistent. Contributes to issue CURA-34.
67 lines
No EOL
3.1 KiB
Python
67 lines
No EOL
3.1 KiB
Python
# Copyright (c) 2015 Ultimaker B.V.
|
|
# Cura is released under the terms of the AGPLv3 or higher.
|
|
|
|
from UM.Mesh.MeshWriter import MeshWriter
|
|
from UM.Logger import Logger
|
|
from UM.Application import Application
|
|
import io
|
|
import re #For escaping characters in the settings.
|
|
|
|
|
|
class GCodeWriter(MeshWriter):
|
|
## Serialisation version ID of the settings that get serialised in g-code.
|
|
#
|
|
# If the format of settings is modified in any way that breaks backwards
|
|
# compatibility, this version number must be incremented.
|
|
settings_version_id = 1
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
|
|
def write(self, stream, node, mode = MeshWriter.OutputMode.TextMode):
|
|
if mode != MeshWriter.OutputMode.TextMode:
|
|
Logger.log("e", "GCode Writer does not support non-text mode")
|
|
return False
|
|
|
|
scene = Application.getInstance().getController().getScene()
|
|
gcode_list = getattr(scene, "gcode_list")
|
|
if gcode_list:
|
|
for gcode in gcode_list:
|
|
stream.write(gcode)
|
|
profile = self._serialiseProfile(Application.getInstance().getMachineManager().getActiveProfile()) #Serialise the profile and put them at the end of the file.
|
|
stream.write(profile)
|
|
return True
|
|
|
|
return False
|
|
|
|
## Serialises the profile to prepare it for saving in the g-code.
|
|
#
|
|
# The profile are serialised, and special characters (including newline)
|
|
# are escaped.
|
|
#
|
|
# \param profile The profile to serialise.
|
|
# \return A serialised string of the profile.
|
|
def _serialiseProfile(self, profile):
|
|
#IF YOU CHANGE THIS FUNCTION IN A WAY THAT BREAKS REVERSE COMPATIBILITY, INCREMENT settings_version_id!
|
|
prefix = ";SETTING_" + str(self.settings_version_id) + " " #The prefix to put before each line.
|
|
|
|
serialised = profile.serialise()
|
|
|
|
#Escape characters that have a special meaning in g-code comments.
|
|
escape_characters = { #Which special characters (keys) are replaced by what escape character (values).
|
|
#Note: The keys are regex strings. Values are not.
|
|
"\\": "\\\\", #The escape character.
|
|
"\n": "\\n", #Newlines. They break off the comment.
|
|
"\r": "\\r" #Carriage return. Windows users may need this for visualisation in their editors.
|
|
}
|
|
escape_characters = dict((re.escape(key), value) for key, value in escape_characters.items())
|
|
pattern = re.compile("|".join(escape_characters.keys()))
|
|
serialised = pattern.sub(lambda m: escape_characters[re.escape(m.group(0))], serialised) #Perform the replacement with a regular expression.
|
|
|
|
#Introduce line breaks so that each comment is no longer than 80 characters. Prepend each line with the prefix.
|
|
result = ""
|
|
for pos in range(0, len(serialised), 80 - len(prefix)): #Lines have 80 characters, so the payload of each line is 80 - prefix.
|
|
result += prefix + serialised[pos : pos + 80 - len(prefix)] + "\n"
|
|
serialised = result
|
|
|
|
return serialised |