vb6parse 1.0.1

vb6parse is a library for parsing and analyzing VB6 code, from projects, to controls, to modules, and forms.
Documentation 
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216

//! Project file (.vbp) parsing errors.

/// Errors that can occur during project file parsing.
#[derive(thiserror::Error, Debug, Clone, PartialEq, Eq)]
pub enum ProjectError {
    /// A section header was not terminated properly.
    #[error("A section header was expected but was not terminated with a ']' character.")]
    UnterminatedSectionHeader,

    /// Property name was not found in a property line.
    #[error("Project property line invalid. Expected a Property Name followed by an equal sign '=' and a Property Value.")]
    PropertyNameNotFound,

    /// Project type is unknown.
    #[error("'Type' property line invalid. Only the values 'Exe', 'OleDll', 'Control', or 'OleExe' are valid.")]
    TypeUnknown,

    /// Designer file not found.
    #[error("'Designer' line is invalid. Expected a designer path after the equal sign '='. Found a newline or the end of the file instead.")]
    DesignerFileNotFound,

    /// Reference compiled UUID missing matching brace.
    #[error("'Reference' line is invalid. The line started with '*\\G' indicating a compiled reference. Expected a closing '}}' after the UUID, but found a newline or the end of the file instead.")]
    ReferenceCompiledUuidMissingMatchingBrace,

    /// Reference compiled UUID is invalid.
    #[error("'Reference' line is invalid. The line started with '*\\G' indicating a compiled reference but the contents of the '{{' and '}}' was not a valid UUID.")]
    ReferenceCompiledUuidInvalid,

    /// Reference project path not found.
    #[error("'Reference' line is invalid. Expected a reference path but found a newline or the end of the file instead.")]
    ReferenceProjectPathNotFound,

    /// Reference project path is invalid.
    #[error("'Reference' line is invalid. Expected a reference path to begin with '*\\A' followed by the path to the reference project file ending with a quote '\"' character. Found '{value}' instead.")]
    ReferenceProjectPathInvalid {
        /// The invalid path value that was found.
        value: String,
    },

    /// Reference compiled unknown1 missing.
    #[error("'Reference' line is invalid. Expected a compiled reference 'unknown1' value after the UUID, between '#' characters but found a newline or the end of the file instead.")]
    ReferenceCompiledUnknown1Missing,

    /// Reference compiled unknown2 missing.
    #[error("'Reference' line is invalid. Expected a compiled reference 'unknown2' value after the UUID and 'unknown1', between '#' characters but found a newline or the end of the file instead.")]
    ReferenceCompiledUnknown2Missing,

    /// Reference compiled path not found.
    #[error("'Reference' line is invalid. Expected a compiled reference 'path' value after the UUID, 'unknown1', and 'unknown2', between '#' characters but found a newline or the end of the file instead.")]
    ReferenceCompiledPathNotFound,

    /// Reference compiled description not found.
    #[error("'Reference' line is invalid. Expected a compiled reference 'description' value after the UUID, 'unknown1', 'unknown2', and 'path', but found a newline or the end of the file instead.")]
    ReferenceCompiledDescriptionNotFound,

    /// Reference compiled description is invalid.
    #[error("'Reference' line is invalid. Compiled reference description contains a '#' character, which is not allowed. The description must be a valid ASCII string without any '#' characters.")]
    ReferenceCompiledDescriptionInvalid,

    /// Object project path not found.
    #[error("'Object' line is invalid. Project based objects lines must be quoted strings and begin with '*\\A' followed by the path to the object project file ending with a quote '\"' character. Found a newline or the end of the file instead.")]
    ObjectProjectPathNotFound,

    /// Object compiled missing opening brace.
    #[error("'Object' line is invalid. Compiled object lines must begin with '{{'. Found a newline or the end of the file instead.")]
    ObjectCompiledMissingOpeningBrace,

    /// Object compiled UUID missing matching brace.
    #[error("'Object' line is invalid. Compiled object lines must begin with '{{', enclose a valid UUID. Expected a closing '}}' after the UUID, but found a newline or the end of the file instead.")]
    ObjectCompiledUuidMissingMatchingBrace,

    /// Object compiled UUID is invalid.
    #[error("'Object' line is invalid. Compiled object lines must begin with '{{', enclose a valid UUID, and end with '}}'. The UUID was not valid. Expected a valid UUID in the format 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' containing only ASCII characters.")]
    ObjectCompiledUuidInvalid,

    /// Object compiled version missing.
    #[error("'Object' line is invalid. Compiled object lines must begin with '{{', enclose a valid UUID with '}}', followed by a '#' character, and then a version number. Expected a '#' character, but found a newline or the end of the file instead.")]
    ObjectCompiledVersionMissing,

    /// Object compiled version is invalid.
    #[error("'Object' line is invalid. Compiled object lines must begin with '{{', enclose a valid UUID with '}}', followed by a '#' character, and then a version number. The version number was not valid. Expected a valid version number in the format 'x.x'. The version number must contain only '.' or the characters \"0\"..\"9\". Invalid character found instead.")]
    ObjectCompiledVersionInvalid,

    /// Object compiled unknown1 missing.
    #[error("'Object' line is invalid. Compiled object lines must begin with '{{', enclose a valid UUID with '}}', followed by '#', a version number, followed by another '#', then an 'unknown1' value followed by \"; \". Expected \"; \", but found a newline or the end of the file instead.")]
    ObjectCompiledUnknown1Missing,

    /// Object compiled file name not found.
    #[error("'Object' line is invalid. Compiled object lines must begin with '{{', enclose a valid UUID with '}}', followed by '#', a version number, followed by another '#', then an 'unknown1' value followed by \"; \", and ending with the object's file name. Expected the object's file name, but found a newline or the end of the file instead.")]
    ObjectCompiledFileNameNotFound,

    /// Module name not found.
    #[error("'Module' line is invalid. Expected a module name followed by a \"; \". Found a newline or the end of the file instead.")]
    ModuleNameNotFound,

    /// Module file name not found.
    #[error("'Module' line is invalid. Expected a module name followed by a \"; \", followed by the module file name. Found a newline or the end of the file instead.")]
    ModuleFileNameNotFound,

    /// Class name not found.
    #[error("'Class' line is invalid. Expected a class name followed by a \"; \". Found a newline or the end of the file instead.")]
    ClassNameNotFound,

    /// Class file name not found.
    #[error("'Class' line is invalid. Expected a class name followed by a \"; \", followed by the class file name. Found a newline or the end of the file instead.")]
    ClassFileNameNotFound,

    /// Path value not found.
    #[error("The '{parameter_line_name}' line is invalid. Expected a '{parameter_line_name}' path after the equal sign '='. Found a newline or the end of the file instead.")]
    PathValueNotFound {
        /// The parameter line name.
        parameter_line_name: String,
    },

    /// Parameter value not found, End of File.
    #[error("The '{parameter_line_name}' line is invalid. Expected a double quoted '{parameter_line_name}' value after the equal sign '='. Found the end of the file instead. Only {valid_value_message} are valid values for '{parameter_line_name}'")]
    ParameterWithDefaultValueNotFoundEOF {
        /// The parameter line name.
        parameter_line_name: String,
        /// Valid values message.
        valid_value_message: String,
    },

    /// Parameter value not found.
    #[error("The '{parameter_line_name}' line is invalid. Expected a quoted '{parameter_line_name}' value after the equal sign '='. Found a newline instead.")]
    ParameterValueNotFound {
        /// The parameter line name.
        parameter_line_name: String,
    },

    /// Parameter value not found. Parameter type has a default.
    #[error("The '{parameter_line_name}' line is invalid. Expected a quoted '{parameter_line_name}' value after the equal sign '='. Found a newline instead. Only {valid_value_message} are valid values for '{parameter_line_name}'")]
    ParameterWithDefaultValueNotFound {
        /// The parameter line name.
        parameter_line_name: String,
        /// Valid values message.
        valid_value_message: String,
    },

    /// Parameter value missing opening quote.
    #[error("The '{parameter_line_name}' line is invalid. '{parameter_line_name}' is missing an opening quote. Expected an opening quote for the '{parameter_line_name}' value.")]
    ParameterValueMissingOpeningQuote {
        /// The parameter line name.
        parameter_line_name: String,
    },

    /// Parameter value missing matching quote.
    #[error("The '{parameter_line_name}' line is invalid. '{parameter_line_name}' is missing a closing quote. Expected a closing quote for the '{parameter_line_name}' value.")]
    ParameterValueMissingClosingQuote {
        /// The parameter line name.
        parameter_line_name: String,
    },

    /// Parameter value is just a double qoute character and is missing a value
    #[error("The '{parameter_line_name}' line is invalid. '{parameter_line_name}' is missing a value and a closing quote. Only {valid_value_message} are valid values for '{parameter_line_name}'.")]
    ParameterValueMissingClosingQuoteAndValue {
        /// The parameter line name.
        parameter_line_name: String,
        /// Valid value message.
        valid_value_message: String,
    },

    /// Parameter value missing quotes.
    #[error("The '{parameter_line_name}' line is invalid. '{parameter_line_name}' is missing both opening and closing quotes. Expected a double quoted '{parameter_line_name}' value after the equal sign '='.")]
    ParameterWithoutDefaultValueMissingQuotes {
        /// The parameter line name.
        parameter_line_name: String,
    },

    /// Parameter value missing quotes.
    #[error("The '{parameter_line_name}' line is invalid. '{parameter_line_name}' is missing both opening and closing quotes. Expected a double quoted '{parameter_line_name}' value after the equal sign '='. Only {valid_value_message} are valid values for '{parameter_line_name}'.")]
    ParameterValueMissingQuotes {
        /// The parameter line name.
        parameter_line_name: String,
        /// Valid value message.
        valid_value_message: String,
    },

    /// Parameter value is invalid.
    #[error("The '{parameter_line_name}' line is invalid. '{invalid_value}' is not a valid value for '{parameter_line_name}'. Only {valid_value_message} are valid values for '{parameter_line_name}'.")]
    ParameterValueInvalid {
        /// The parameter line name.
        parameter_line_name: String,
        /// The invalid value that was found.
        invalid_value: String,
        /// Valid value message.
        valid_value_message: String,
    },

    /// `DllBaseAddress` not found.
    #[error("'DllBaseAddress' line is invalid. Expected a hex address after the equal sign '='. Found a newline or the end of the file instead.")]
    DllBaseAddressNotFound,

    /// `DllBaseAddress` missing hex prefix.
    #[error("'DllBaseAddress' line is invalid. Expected a valid hex address beginning with '&h' after the equal sign '='.")]
    DllBaseAddressMissingHexPrefix,

    /// `DllBaseAddress` unparsable.
    #[error("'DllBaseAddress' line is invalid. Expected a valid hex address after the equal sign '=' beginning with '&h'. Unable to parse hex value '{hex_value}'.")]
    DllBaseAddressUnparsable {
        /// The hex value that couldn't be parsed.
        hex_value: String,
    },

    /// `DllBaseAddress` unparsable (empty).
    #[error("'DllBaseAddress' line is invalid. Expected a valid hex address after the equal sign '=' beginning with '&h'. Unable to parse empty hex value.")]
    DllBaseAddressUnparsableEmpty,

    /// Parameter line is unknown.
    #[error("'{line}' line is unknown.")]
    ParameterLineUnknown {
        /// The parameter line that is unknown.
        line: String,
    },
}