3D-printing/Cura
1
0
Fork 0
mirror of https://github.com/Ultimaker/Cura.git synced 2025-07-06 22:47:29 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Limit g-code comments to 80 characters and add prefix

Browse source 
The prefix is of the form ;SETTING_n where n is the version ID of the profile serialisation.

Contributes to issue CURA-34.
This commit is contained in:
Ghostkeeper 2015-12-09 17:05:05 +01:00
parent 914ea8ba39
commit 398dd60637
1 changed files with 12 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

17
plugins/GCodeWriter/GCodeWriter.py
View file

@ -36,6 +36,9 @@ class GCodeWriter(MeshWriter):
# \param profile The profile to serialise.
# \return A serialised string of the profile.
def _serialiseProfile(self, profile):
version = 1 #IF YOU CHANGE THIS FUNCTION IN A WAY THAT BREAKS REVERSE COMPATIBILITY, INCREMENT THIS VERSION NUMBER!
prefix = ";SETTING_" + str(version) + " " #The prefix to put before each line.
serialised = profile.serialise()
#Escape characters that have a special meaning in g-code comments.
@ -43,12 +46,16 @@ class GCodeWriter(MeshWriter):
#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.
"\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[m.group(0)], serialised) #Perform the replacement with a regular expression.
serialised = pattern.sub(lambda m: escape_characters[re.escape(m.group(0))], serialised) #Perform the replacement with a regular expression.
#TODO: Introduce line breaks so that each comment is no longer than 80 characters.
#TODO: Prepend a prefix that includes the keyword "SETTING" and a serialised version number.
#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
return serialised