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
|
/*
* StringParser.h
*
* Created on: 6 Feb 2015
* Author: David
*/
#ifndef SRC_GCODES_GCODEBUFFER_STRINGGCODEBUFFER_H
#define SRC_GCODES_GCODEBUFFER_STRINGGCODEBUFFER_H
#include <RepRapFirmware.h>
#include <GCodes/GCodeInput.h>
#include <GCodes/GCodeMachineState.h>
#include <ObjectModel/ObjectModel.h>
#include <GCodes/GCodeException.h>
#include <Networking/NetworkDefs.h>
class GCodeBuffer;
class IPAddress;
class MacAddress;
class VariableSet;
class StringParser
{
public:
StringParser(GCodeBuffer& gcodeBuffer) noexcept;
void Init() noexcept; // Set it up to parse another G-code
void Diagnostics(MessageType mtype) noexcept; // Write some debug info
bool Put(char c) noexcept SPEED_CRITICAL; // Add a character to the end
void PutCommand(const char *str) noexcept; // Put a complete command but don't decode it
void DecodeCommand() noexcept; // Decode the next command in the line
void PutAndDecode(const char *str, size_t len) noexcept; // Add an entire string, overwriting any existing content
void PutAndDecode(const char *str) noexcept; // Add a null-terminated string, overwriting any existing content
void StartNewFile() noexcept; // Called when we start a new file
bool FileEnded() noexcept; // Called when we reach the end of the file we are reading from
bool CheckMetaCommand(const StringRef& reply) THROWS(GCodeException); // Check whether the current command is a meta command, or we are skipping block
// The following may be called after calling DecodeCommand
char GetCommandLetter() const noexcept { return commandLetter; }
bool HasCommandNumber() const noexcept { return hasCommandNumber; }
int GetCommandNumber() const noexcept { return commandNumber; }
int8_t GetCommandFraction() const noexcept { return commandFraction; }
bool IsLastCommand() const noexcept;
bool ContainsExpression() const noexcept { return seenExpression; }
bool Seen(char c) noexcept SPEED_CRITICAL; // Is a character present?
float GetFValue() THROWS(GCodeException) SPEED_CRITICAL; // Get a float after a key letter
float GetDistance() THROWS(GCodeException) SPEED_CRITICAL; // Get a distance or coordinate and convert it from inches to mm if necessary
int32_t GetIValue() THROWS(GCodeException) SPEED_CRITICAL; // Get an integer after a key letter
uint32_t GetUIValue() THROWS(GCodeException); // Get an unsigned integer value
DriverId GetDriverId() THROWS(GCodeException); // Get a driver ID
void GetIPAddress(IPAddress& returnedIp) THROWS(GCodeException); // Get an IP address quad after a key letter
void GetMacAddress(MacAddress& mac) THROWS(GCodeException); // Get a MAC address sextet after a key letter
void GetUnprecedentedString(const StringRef& str, bool allowEmpty) THROWS(GCodeException); // Get a string with no preceding key letter
void GetCompleteParameters(const StringRef& str) const noexcept; // Get the complete parameter string
void GetQuotedString(const StringRef& str, bool allowEmpty) THROWS(GCodeException); // Get and copy a quoted string
void GetPossiblyQuotedString(const StringRef& str, bool allowEmpty) THROWS(GCodeException); // Get and copy a string which may or may not be quoted
void GetFloatArray(float arr[], size_t& length, bool doPad) THROWS(GCodeException) SPEED_CRITICAL; // Get a colon-separated list of floats after a key letter
void GetIntArray(int32_t arr[], size_t& length, bool doPad) THROWS(GCodeException); // Get a :-separated list of ints after a key letter
void GetUnsignedArray(uint32_t arr[], size_t& length, bool doPad) THROWS(GCodeException); // Get a :-separated list of unsigned ints after a key letter
void GetDriverIdArray(DriverId arr[], size_t& length) THROWS(GCodeException); // Get a :-separated list of drivers after a key letter
void SetFinished() noexcept; // Set the G Code finished
void SetCommsProperties(uint32_t arg) noexcept { checksumRequired = (arg & 1); }
#if HAS_MASS_STORAGE
bool OpenFileToWrite(const char* directory, const char* fileName, const FilePosition size, const bool binaryWrite, const uint32_t fileCRC32) noexcept;
// Open a file to write to
bool IsWritingFile() const noexcept { return fileBeingWritten != nullptr; } // Returns true if writing a file
void WriteToFile() noexcept; // Write the current GCode to file
bool IsWritingBinary() const noexcept { return IsWritingFile() && binaryWriting; } // Returns true if writing binary
bool WriteBinaryToFile(char b) noexcept; // Write a byte to the file
void FinishWritingBinary() noexcept;
#endif
FilePosition GetFilePosition() const noexcept; // Get the file position at the start of the current command
const char* DataStart() const noexcept; // Get the start of the current command
size_t DataLength() const noexcept; // Get the length of the current command
void PrintCommand(const StringRef& s) const noexcept;
void AppendFullCommand(const StringRef &s) const noexcept;
void SetParameters(VariableSet& vs, int codeRunning) noexcept;
GCodeException ConstructParseException(const char *str) const noexcept;
GCodeException ConstructParseException(const char *str, const char *param) const noexcept;
GCodeException ConstructParseException(const char *str, uint32_t param) const noexcept;
private:
GCodeBuffer& gb;
void AddToChecksum(char c) noexcept;
void StoreAndAddToChecksum(char c) noexcept;
bool LineFinished() THROWS(GCodeException); // Deal with receiving end-of-line and return true if we have a command
void InternalGetQuotedString(const StringRef& str) THROWS(GCodeException)
pre (readPointer >= 0; gb.buffer[readPointer] == '"'; str.IsEmpty());
void InternalGetPossiblyQuotedString(const StringRef& str) THROWS(GCodeException)
pre (readPointer >= 0);
float ReadFloatValue() THROWS(GCodeException);
uint32_t ReadUIValue() THROWS(GCodeException);
int32_t ReadIValue() THROWS(GCodeException);
DriverId ReadDriverIdValue() THROWS(GCodeException);
void CheckArrayLength(size_t actualLength, size_t maxLength) THROWS(GCodeException);
void CheckNumberFound(const char *endptr) THROWS(GCodeException);
void CheckForMixedSpacesAndTabs() noexcept;
bool ProcessConditionalGCode(const StringRef& reply, BlockType skippedBlockType, bool doingFile) THROWS(GCodeException);
// Check for and process a conditional GCode language command returning true if we found one
void ProcessIfCommand() THROWS(GCodeException);
void ProcessElseCommand(BlockType skippedBlockType) THROWS(GCodeException);
void ProcessElifCommand(BlockType skippedBlockType) THROWS(GCodeException);
void ProcessWhileCommand() THROWS(GCodeException);
void ProcessBreakCommand() THROWS(GCodeException);
void ProcessContinueCommand() THROWS(GCodeException);
void ProcessVarOrGlobalCommand(bool isGlobal) THROWS(GCodeException);
void ProcessSetCommand() THROWS(GCodeException);
void ProcessAbortCommand(const StringRef& reply) noexcept;
void ProcessEchoCommand(const StringRef& reply) THROWS(GCodeException);
bool EvaluateCondition() THROWS(GCodeException);
void SkipWhiteSpace() noexcept;
unsigned int commandStart; // Index in the buffer of the command letter of this command
unsigned int parameterStart;
unsigned int commandEnd; // Index in the buffer of one past the last character of this command
unsigned int commandLength; // Number of characters we read to build this command including the final \r or \n
unsigned int braceCount; // how many nested { } we are inside
unsigned int gcodeLineEnd; // Number of characters in the entire line of gcode
Bitmap<uint32_t> parametersPresent; // which parameters are present in this command
int readPointer; // Where in the buffer to read next, or -1
FileStore *fileBeingWritten; // If we are copying GCodes to a file, which file it is
FilePosition writingFileSize; // Size of the file being written, or zero if not known
unsigned int receivedLineNumber;
unsigned int declaredChecksum;
int commandNumber;
uint32_t crc32; // crc32 of the binary file
uint32_t whenTimerStarted; // when we started waiting
uint8_t eofStringCounter; // Check the EOF
uint16_t indentToSkipTo;
static constexpr uint16_t NoIndentSkip = 0xFFFF; // must be greater than any real indent
uint8_t computedChecksum;
bool hadLineNumber;
bool hadChecksum;
bool hasCommandNumber;
char commandLetter;
uint8_t commandIndent; // Number of whitespace characters before the line number or the first command starts
bool seenLeadingSpace;
bool seenLeadingTab;
bool seenMetaCommand;
bool warnedAboutMixedSpacesAndTabs;
bool overflowed;
bool seenExpression;
bool checksumRequired; // True if we only accept commands with a valid checksum
int8_t commandFraction;
bool binaryWriting; // Executing gcode or writing binary file?
};
#endif /* SRC_GCODES_GCODEBUFFER_STRINGGCODEBUFFER_H */
|
