feat(label): add ZGLabel and ZGDocumentLabelManager implementations

Author: Wessel van der Veen

Bit Slicer.xcodeproj/project.pbxproj

@@ -7,6 +7,8 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		4E1220AD297C747000E3166F /* ZGDocumentLabelManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 4E1220AC297C747000E3166F /* ZGDocumentLabelManager.m */; };
+		4E1220AF297D432D00E3166F /* ZGLabel.m in Sources */ = {isa = PBXBuildFile; fileRef = 4E1220AE297D432D00E3166F /* ZGLabel.m */; };
 		72030ADC1B00191400A5621C /* ZGScriptingInterpreter.m in Sources */ = {isa = PBXBuildFile; fileRef = 72030ADB1B00191400A5621C /* ZGScriptingInterpreter.m */; };
 		720844FA24E0715C00F3D449 /* DataInspector.m in Sources */ = {isa = PBXBuildFile; fileRef = 720844F924E0715C00F3D449 /* DataInspector.m */; };
 		720844FD24E072DB00F3D449 /* DataInspectorScrollView.m in Sources */ = {isa = PBXBuildFile; fileRef = 720844FC24E072DB00F3D449 /* DataInspectorScrollView.m */; };
@@ -301,6 +303,10 @@
 /* End PBXCopyFilesBuildPhase section */
 
 /* Begin PBXFileReference section */
+		4E1220AB297C745900E3166F /* ZGDocumentLabelManager.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = ZGDocumentLabelManager.h; path = "Bit Slicer/ZGDocumentLabelManager.h"; sourceTree = "<group>"; };
+		4E1220AC297C747000E3166F /* ZGDocumentLabelManager.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; name = ZGDocumentLabelManager.m; path = "Bit Slicer/ZGDocumentLabelManager.m"; sourceTree = "<group>"; };
+		4E1220AE297D432D00E3166F /* ZGLabel.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; name = ZGLabel.m; path = "Bit Slicer/ZGLabel.m"; sourceTree = "<group>"; };
+		4E1220B0297D433700E3166F /* ZGLabel.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = ZGLabel.h; path = "Bit Slicer/ZGLabel.h"; sourceTree = "<group>"; };
 		72030ADA1B00191400A5621C /* ZGScriptingInterpreter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = ZGScriptingInterpreter.h; path = "Bit Slicer/ZGScriptingInterpreter.h"; sourceTree = "<group>"; };
 		72030ADB1B00191400A5621C /* ZGScriptingInterpreter.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = ZGScriptingInterpreter.m; path = "Bit Slicer/ZGScriptingInterpreter.m"; sourceTree = "<group>"; };
 		720844F824E0715C00F3D449 /* DataInspector.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = DataInspector.h; path = deps/HexFiend/DataInspector.h; sourceTree = "<group>"; };
@@ -1324,6 +1330,8 @@
 				77FFC104186BDA3600122357 /* ZGWatchVariableWindowController.h */,
 				77FFC105186BDA3600122357 /* ZGWatchVariableWindowController.m */,
 				7739728017D26A1600B958EE /* Scripting */,
+				4E1220AB297C745900E3166F /* ZGDocumentLabelManager.h */,
+				4E1220AC297C747000E3166F /* ZGDocumentLabelManager.m */,
 			);
 			name = Documents;
 			sourceTree = "<group>";
@@ -1461,6 +1469,8 @@
 				77F1162B17D2EF50009E002A /* ZGVariable.m */,
 				7231440619C607C700FBE342 /* ZGWatchVariable.h */,
 				7231440719C607C700FBE342 /* ZGWatchVariable.m */,
+				4E1220AE297D432D00E3166F /* ZGLabel.m */,
+				4E1220B0297D433700E3166F /* ZGLabel.h */,
 			);
 			name = Models;
 			sourceTree = "<group>";
@@ -1701,6 +1711,7 @@
 				770F284218832132001B828C /* ZGBreakPointCondition.m in Sources */,
 				77F115D617D2ED8E009E002A /* ZGLineCountingRepresenter.m in Sources */,
 				772D1268190E0D8600800B1B /* ZGHotKeyPreferencesViewController.m in Sources */,
+				4E1220AD297C747000E3166F /* ZGDocumentLabelManager.m in Sources */,
 				771A931D18791A8D0098511D /* ZGTableView.m in Sources */,
 				77F115D917D2ED9D009E002A /* ZGLineCountingView.m in Sources */,
 				77607AB1185CD50100AC532B /* AGScopeBar.m in Sources */,
@@ -1791,6 +1802,7 @@
 				77F1165917D2F001009E002A /* ZGRegister.m in Sources */,
 				774B5EE61915361400D7AA69 /* ZGPyKeyCodeModule.m in Sources */,
 				7231440819C607C700FBE342 /* ZGWatchVariable.m in Sources */,
+				4E1220AF297D432D00E3166F /* ZGLabel.m in Sources */,
 				77179F6B18CD34F100BCB6D0 /* ZGAppUpdaterController.m in Sources */,
 				77F1165C17D2F00A009E002A /* ZGCodeInjectionWindowController.m in Sources */,
 				77CE28B717D538E300998F28 /* ZGLoggerWindowController.m in Sources */,

Bit Slicer/ZGCalculator.h

@@ -32,6 +32,7 @@
 
 #import <Foundation/Foundation.h>
 #import "ZGVariable.h"
+#import "ZGDocumentLabelManager.h"
 
 @class ZGProcess;
 
@@ -41,6 +42,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface ZGVariable (ZGCalculatorAdditions)
 
+@property (nonatomic, readonly) BOOL usesDynamicLabelAddress;
 @property (nonatomic, readonly) BOOL usesDynamicPointerAddress;
 @property (nonatomic, readonly) BOOL usesDynamicBaseAddress;
 
@@ -54,7 +56,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 // Can evaluate [address] + [address2] + offset, [address + [address2 - [address3]]] + offset, etc...
 // And also has a base() function that takes in a string, and returns the first address to a region such that the passed string partially matches the end of the corresponding region's mapped path
-+ (nullable NSString *)evaluateExpression:(NSString *)expression process:(ZGProcess *)process failedImages:(nullable NSMutableArray<NSString *> *)failedImages error:(NSError **)error;
++ (nullable NSString *)evaluateExpression:(NSString *)expression documentLabelManager:(ZGDocumentLabelManager *)documentLabelManager process:(ZGProcess *)process failedImages:(nullable NSMutableArray<NSString *> *)failedImages error:(NSError **)error;
 + (nullable NSString *)evaluateAndSymbolicateExpression:(NSString *)expression process:(ZGProcess *)process currentAddress:(ZGMemoryAddress)currentAddress didSymbolicate:(nullable BOOL *)didSymbolicate error:(NSError **)error;
 
 @end

Bit Slicer/ZGCalculator.m

@@ -32,10 +32,12 @@
 
 #import "ZGCalculator.h"
 #import "NSStringAdditions.h"
+#import "ZGDocumentLabelManager.h"
 #import "ZGVirtualMemory.h"
 #import "ZGMachBinary.h"
 #import "ZGMachBinaryInfo.h"
 #import "ZGRegion.h"
+#import "ZGLabel.h"
 #import "ZGProcess.h"
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wincomplete-umbrella"
@@ -49,17 +51,24 @@
 
 #define ZGCalculatePointerFunction @"ZGCalculatePointerFunction"
 #define ZGFindSymbolFunction @"symbol"
+#define ZGFindLabelFunction @"label"
 #define ZGProcessVariable @"ZGProcessVariable"
+#define ZGDocumentLabelManagerVariable @"ZGDocumentLabelManagerVariable"
 #define ZGFailedImagesVariable @"ZGFailedImagesVariable"
 #define ZGSymbolicatesVariable @"ZGSymbolicatesVariable"
 #define ZGDidFindSymbol @"ZGDidFindSymbol"
 #define ZGLastSearchInfoVariable @"ZGLastSearchInfoVariable"
 
 @implementation ZGVariable (ZGCalculatorAdditions)
 
+- (BOOL)usesDynamicLabelAddress
+{
+	return _addressFormula != nil && [_addressFormula rangeOfString:ZGFindLabelFunction].location != NSNotFound;
+}
+
 - (BOOL)usesDynamicPointerAddress
 {
-	return _addressFormula != nil && [_addressFormula rangeOfString:@"["].location != NSNotFound && [_addressFormula rangeOfString:@"]"].location != NSNotFound;
+	return _addressFormula != nil && ([_addressFormula rangeOfString:@"["].location != NSNotFound && [_addressFormula rangeOfString:@"]"].location != NSNotFound);
 }
 
 - (BOOL)usesDynamicBaseAddress
@@ -236,6 +245,62 @@ + (DDMathFunction)registerFindSymbolFunctionWithEvaluator:(DDMathEvaluator *)eva
 	return findSymbolFunction;
 }
 
++ (DDMathFunction)registerFindLabelFunctionWithEvaluator:(DDMathEvaluator *)evaluator
+{
+	DDMathFunction findLabelFunction = ^DDExpression *(NSArray<DDExpression *> *args, NSDictionary<NSString *, id> *vars, DDMathEvaluator * __unused eval, NSError *__autoreleasing *error) {
+		ZGDocumentLabelManager *documentLabelManager = [vars objectForKey:ZGDocumentLabelManagerVariable];
+		
+		__block NSNumber *labelAddressNumber = @(0);
+
+		if (args.count == 0 || args.count > 1)
+		{
+			if (error != NULL)
+			{
+				*error = [NSError errorWithDomain:DDMathParserErrorDomain code:DDErrorCodeInvalidNumberOfArguments userInfo:@{NSLocalizedDescriptionKey:ZGFindLabelFunction @" expects 1 argument"}];
+			}
+		}
+		else if (documentLabelManager == nil || [documentLabelManager.labels count] == 0)
+		{
+			if (error != NULL)
+			{
+				*error = [NSError errorWithDomain:DDMathParserErrorDomain code:DDErrorCodeUnresolvedVariable userInfo:@{NSLocalizedDescriptionKey:ZGFindLabelFunction @" expects a labels variable"}];
+			}
+		}
+		else
+		{
+			DDExpression *labelExpression = [args objectAtIndex:0];
+
+			if (labelExpression.expressionType != DDExpressionTypeVariable)
+			{
+				if (error != NULL)
+				{
+					*error = [NSError errorWithDomain:DDMathParserErrorDomain code:DDErrorCodeUnresolvedVariable userInfo:@{NSLocalizedDescriptionKey:ZGFindLabelFunction @" expects a string variable"}];
+				}
+			}
+			else
+			{
+				NSString *labelString = labelExpression.variable;
+				ZGLabel *label = [documentLabelManager.labels objectForKey:labelString];
+				
+				labelAddressNumber = @(label.address);
+				if (labelAddressNumber == nil)
+				{
+					if (error != NULL)
+					{
+						*error = [NSError errorWithDomain:DDMathParserErrorDomain code:DDErrorCodeInvalidArgument userInfo:@{NSLocalizedDescriptionKey:ZGFindLabelFunction @" could not find requested label"}];
+					}
+				}
+			}
+		}
+		
+		return [DDExpression numberExpressionWithNumber:labelAddressNumber];
+	};
+	
+	[evaluator registerFunction:findLabelFunction forName:ZGFindLabelFunction];
+	
+	return findLabelFunction;
+}
+
 + (void)registerFunctionResolverWithEvaluator:(DDMathEvaluator *)evaluator findSymbolFunction:(DDMathFunction)findSymbolFunction
 {
 	evaluator.functionResolver = (DDFunctionResolver)^(NSString *name) {
@@ -262,6 +327,7 @@ + (void)initialize
 		DDMathEvaluator *evaluator = [DDMathEvaluator defaultMathEvaluator];
 		[self registerCalculatePointerFunctionWithEvaluator:evaluator];
 		[self registerBaseAddressFunctionWithEvaluator:evaluator];
+		[self registerFindLabelFunctionWithEvaluator:evaluator];
 		DDMathFunction findSymbolFunction = [self registerFindSymbolFunctionWithEvaluator:evaluator];
 		[self registerFunctionResolverWithEvaluator:evaluator findSymbolFunction:findSymbolFunction];
 	});
@@ -479,12 +545,17 @@ + (NSString *)expressionBySubstitutingCalculatePointerFunctionInExpression:(NSSt
 	return [[NSString alloc] initWithData:newData encoding:NSUTF8StringEncoding];
 }
 
-+ (NSString *)evaluateExpression:(NSString *)expression process:(ZGProcess * __unsafe_unretained)process failedImages:(NSMutableArray<NSString *> * __unsafe_unretained)failedImages symbolicates:(BOOL)symbolicates foundSymbol:(BOOL *)foundSymbol currentAddress:(ZGMemoryAddress)currentAddress error:(NSError * __autoreleasing *)error
++ (NSString *)evaluateExpression:(NSString *)expression documentLabelManager:(ZGDocumentLabelManager * __unsafe_unretained)documentLabelManager process:(ZGProcess * __unsafe_unretained)process failedImages:(NSMutableArray<NSString *> * __unsafe_unretained)failedImages symbolicates:(BOOL)symbolicates foundSymbol:(BOOL *)foundSymbol currentAddress:(ZGMemoryAddress)currentAddress error:(NSError * __autoreleasing *)error
 {
 	NSString *newExpression = [self expressionBySubstitutingCalculatePointerFunctionInExpression:expression];
 
 	NSMutableDictionary<NSString *, id> *substitutions = [NSMutableDictionary dictionaryWithDictionary:@{ZGProcessVariable : process, ZGSymbolicatesVariable : @(symbolicates), ZGLastSearchInfoVariable : @(currentAddress), ZGDidFindSymbol : @(NO)}];
 
+	if (documentLabelManager != nil)
+	{
+		[substitutions setObject:documentLabelManager forKey:ZGDocumentLabelManagerVariable];
+	}
+	
 	if (failedImages != nil)
 	{
 		[substitutions setObject:failedImages forKey:ZGFailedImagesVariable];
@@ -501,12 +572,12 @@ + (NSString *)evaluateExpression:(NSString *)expression process:(ZGProcess * __u
 
 + (NSString *)evaluateAndSymbolicateExpression:(NSString *)expression process:(ZGProcess * __unsafe_unretained)process currentAddress:(ZGMemoryAddress)currentAddress didSymbolicate:(BOOL *)didSymbolicate error:(NSError * __autoreleasing *)error
 {
-	return [self evaluateExpression:expression process:process failedImages:nil symbolicates:YES foundSymbol:didSymbolicate currentAddress:currentAddress error:error];
+	return [self evaluateExpression:expression documentLabelManager:NULL process:process failedImages:nil symbolicates:YES foundSymbol:didSymbolicate currentAddress:currentAddress error:error];
 }
 
-+ (NSString *)evaluateExpression:(NSString *)expression process:(ZGProcess * __unsafe_unretained)process failedImages:(NSMutableArray<NSString *> * __unsafe_unretained)failedImages error:(NSError * __autoreleasing *)error
++ (NSString *)evaluateExpression:(NSString *)expression documentLabelManager:(ZGDocumentLabelManager * __unsafe_unretained)documentLabelManager process:(ZGProcess * __unsafe_unretained)process failedImages:(NSMutableArray<NSString *> * __unsafe_unretained)failedImages error:(NSError * __autoreleasing *)error
 {
-	return [self evaluateExpression:expression process:process failedImages:failedImages symbolicates:NO foundSymbol:NULL currentAddress:0x0 error:error];
+	return [self evaluateExpression:expression documentLabelManager:documentLabelManager process:process failedImages:failedImages symbolicates:NO foundSymbol:NULL currentAddress:0x0 error:error];
 }
 
 @end

Bit Slicer/ZGDocument.m

@@ -35,6 +35,7 @@
 #import "ZGDocumentData.h"
 #import "ZGSearchData.h"
 #import "ZGVariable.h"
+#import "ZGLabel.h"
 #import "ZGScriptManager.h"
 
 @implementation ZGDocument
@@ -90,13 +91,19 @@ - (NSFileWrapper *)fileWrapperOfType:(NSString *)__unused typeName error:(NSErro
 	NSKeyedArchiver *keyedArchiver = [[NSKeyedArchiver alloc] initForWritingWithMutableData:writeData];
 
 	NSArray<ZGVariable *> *watchVariablesArrayToSave = nil;
+	NSArray<ZGLabel *> *labelsArrayToSave = nil;
 
 	watchVariablesArrayToSave = _data.variables;
+	labelsArrayToSave = _data.labels;
 
 	[keyedArchiver
 	 encodeObject:watchVariablesArrayToSave
 	 forKey:ZGWatchVariablesArrayKey];
 
+	[keyedArchiver
+	 encodeObject:labelsArrayToSave
+	 forKey:ZGLabelsArrayKey];
+	
 	[keyedArchiver
 	 encodeObject:_data.desiredProcessInternalName != nil ? _data.desiredProcessInternalName : [NSNull null]
 	 forKey:ZGProcessInternalNameKey];
@@ -186,6 +193,16 @@ - (BOOL)readFromFileWrapper:(NSFileWrapper *)fileWrapper ofType:(NSString *)__un
 		_data.variables = [NSArray array];
 	}
 
+	NSArray<ZGLabel *> *newLabels = [keyedUnarchiver decodeObjectOfClass:[NSArray class] forKey:ZGLabelsArrayKey];
+	if (newLabels != nil)
+	{
+		_data.labels = newLabels;
+	}
+	else
+	{
+		_data.labels = [NSArray array];
+	}
+	
 	id desiredProcessInternalName = [keyedUnarchiver decodeObjectOfClass:[NSObject class] forKey:ZGProcessInternalNameKey];
 	if (desiredProcessInternalName == [NSNull null] || ![(id<NSObject>)desiredProcessInternalName isKindOfClass:[NSString class]])
 	{

Bit Slicer/ZGDocumentData.h

@@ -33,6 +33,7 @@
 #import <Foundation/Foundation.h>
 
 #define ZGWatchVariablesArrayKey @"ZGWatchVariablesArrayKey"
+#define ZGLabelsArrayKey @"ZGLabelsArrayKey"
 #define ZGProcessInternalNameKey @"ZGProcessNameKey"
 
 #define ZGSelectedDataTypeTag @"ZGSelectedDataTypeTag"
@@ -55,6 +56,7 @@
 NS_ASSUME_NONNULL_BEGIN
 
 @class ZGVariable;
+@class ZGLabel;
 
 @interface ZGDocumentData : NSObject
 
@@ -67,6 +69,7 @@ NS_ASSUME_NONNULL_BEGIN
 @property (copy, nonatomic) NSString *endingAddressStringValue;
 @property (copy, nonatomic) NSString *searchValue;
 @property (nonatomic) NSArray<ZGVariable *> *variables;
+@property (nonatomic) NSArray<ZGLabel *> *labels;
 @property (copy, nonatomic, nullable) NSString *desiredProcessInternalName;
 @property (copy, nonatomic) NSString *lastEpsilonValue;
 @property (copy, nonatomic, nullable) NSString *lastAboveRangeValue;

Bit Slicer/ZGDocumentData.m

@@ -35,6 +35,7 @@
 #import "ZGSearchData.h"
 #import "ZGSearchFunctions.h"
 #import "ZGVariable.h"
+#import "ZGLabel.h"
 
 @implementation ZGDocumentData
 
@@ -44,6 +45,7 @@ - (id)init
 	if (self != nil)
 	{
 		_variables = [[NSArray alloc] init];
+		_labels = [[NSArray alloc] init];
 		_beginningAddressStringValue = @"";
 		_endingAddressStringValue = @"";
 		_searchValue = @"";

Bit Slicer/ZGDocumentLabelManager.h

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2013 Mayur Pawashe
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * Neither the name of the project's author nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#import <Foundation/Foundation.h>
+
+@class ZGLabel;
+@class ZGDocumentData;
+
+@interface ZGDocumentLabelManager : NSObject
+
+NS_ASSUME_NONNULL_BEGIN
+
+@property (nonatomic, readonly) NSMutableDictionary<NSString *, ZGLabel *> *labels;
+
+- (id)initWithDocumentData:(ZGDocumentData *)documentData;
+
+- (void)addLabel:(ZGLabel *)label;
+- (void)removeLabel:(NSString *)name;
+
+@end
+
+NS_ASSUME_NONNULL_END