Initial commit of the new SPMySQL Framework, which is added to the project and ready for use but not yet integrated. This new framework should provide much of the functionality required from MCPKit and is based around its interface for relatively easy integration. The largest missing component is Hans' structure code which I believe is better placed outside the framework.

From the Readme file:

The SPMySQL Framework is intended to provide a stable MySQL connection framework, with the ability to run text-based queries and rapidly retrieve result sets with conversion from MySQL data types to Cocoa objects.

SPMySQL.framework has an interface loosely based around that provided by MCPKit by Serge Cohen and Bertrand Mansion (http://mysql-cocoa.sourceforge.net/), and in particular the heavily modified Sequel Pro version (http://www.sequelpro.com/).  It is a full rewrite of the original framework, although it includes code from patches implementing the following Sequel Pro functionality, largely contributed by Hans-Jörg Bibiko, Stuart Connolly, Jakob Egger, and Rowan Beentje:
	- Connection locking (Jakob et al)
	- Ping & keepalive (Rowan et al)
	- Query cancellation (Rowan et al)
	- Delegate setup (Stuart et al)
	- SSL support (Rowan et al)
	- Connection checking (Rowan et al)
	- Version state (Stuart et al)
	- Maximum packet size control (Hans et al)
	- Result multithreading and streaming (Rowan et al)
	- Improved encoding support & switching (Rowan et al)
	- Database structure; moved to inside the app (Hans et al)
	- Query reattempts and error-handling approach (Rowan et al)
	- Geometry result class (Hans et al)
	- Connection proxy (Stuart et al)

1 files changed, 120 insertions, 0 deletions

diff --git a/Frameworks/SPMySQLFramework/Source/SPMySQLResult.h b/Frameworks/SPMySQLFramework/Source/SPMySQLResult.h
new file mode 100644
index 00000000..baddf8aa
--- /dev/null
+++ b/Frameworks/SPMySQLFramework/Source/SPMySQLResult.h
@@ -0,0 +1,120 @@
+//
+//  $Id$
+//
+//  SPMySQLResult.h
+//  SPMySQLFramework
+//
+//  Created by Rowan Beentje (rowan.beent.je) on January 26, 2012
+//  Copyright (c) 2012 Rowan Beentje. All rights reserved.
+//
+//  Permission is hereby granted, free of charge, to any person
+//  obtaining a copy of this software and associated documentation
+//  files (the "Software"), to deal in the Software without
+//  restriction, including without limitation the rights to use,
+//  copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the
+//  Software is furnished to do so, subject to the following
+//  conditions:
+//
+//  The above copyright notice and this permission notice shall be
+//  included in all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+//  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+//  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+//  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+//  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+//  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+//  OTHER DEALINGS IN THE SOFTWARE.
+//
+//  More info at <http://code.google.com/p/sequel-pro/>
+
+
+typedef enum {
+	SPMySQLResultFieldAsUnhandled    = 0,
+	SPMySQLResultFieldAsString       = 1,
+	SPMySQLResultFieldAsStringOrBlob = 2,
+	SPMySQLResultFieldAsBlob         = 3,
+	SPMySQLResultFieldAsBit          = 4,
+	SPMySQLResultFieldAsGeometry     = 5,
+	SPMySQLResultFieldAsNull         = 6
+} SPMySQLResultFieldProcessor;
+
+@interface SPMySQLResult : NSObject <NSFastEnumeration> {
+
+	// Wrapped MySQL result set and its encoding
+	struct st_mysql_res *resultSet;
+	NSStringEncoding stringEncoding;
+
+	// Number of fields in the result set, and the field names and information
+	NSUInteger numberOfFields;
+	struct st_mysql_field *fieldDefinitions;
+	unsigned int *fieldTypes;
+	NSString **fieldNames;
+	
+	// Number of rows in the result set and an internal data position counter
+	unsigned long long numberOfRows;
+	unsigned long long currentRowIndex;
+
+	// How long it took to execute the query that produced this result
+	double queryExecutionTime;
+
+	// The target result set type for fast enumeration and unspecified row retrieval
+	SPMySQLResultRowType defaultRowReturnType;
+
+	// Whether all data should be returned as strings - useful for working with some older server types
+	BOOL returnDataAsStrings;
+}
+
+// Master init method
+- (id)initWithMySQLResult:(void *)theResult stringEncoding:(NSStringEncoding)theStringEncoding;
+
+// Result set information
+- (NSUInteger)numberOfFields;
+- (unsigned long long)numberOfRows;
+
+// Column information
+- (NSArray *)fieldNames;
+
+// Data retrieval (note that fast enumeration is also supported, using instance-default format)
+- (void)seekToRow:(unsigned long long)targetRow;
+- (id)getRow;
+- (NSArray *)getRowAsArray;
+- (NSDictionary *)getRowAsDictionary;
+- (id)getRowAsType:(SPMySQLResultRowType)theType;
+
+// Data conversion
++ (NSString *)bitStringWithBytes:(const char *)bytes length:(NSUInteger)length padToLength:(NSUInteger)padLength;
+
+#pragma mark -
+#pragma mark Synthesized properties
+
+/**
+ * Set whether the result should return data types as strings.  This may be useful
+ * for queries where the result may be returned in either string or data form, but
+ * will be converted to string for display and use anyway.
+ * Note that certain MySQL versions also return data types for strings - eg SHOW
+ * commands like SHOW CREATE TABLE or SHOW VARIABLES, and this conversion can be
+ * necessary there.
+ */
+@property (readwrite, assign) BOOL returnDataAsStrings;
+
+@property (readwrite, assign) SPMySQLResultRowType defaultRowReturnType;
+
+@end
+
+/**
+ * Set up a static function to allow fast calling with cached selectors
+ */
+static inline id SPMySQLResultGetRow(SPMySQLResult* self, SPMySQLResultRowType rowType) 
+{
+	typedef id (*SPMySQLResultGetRowMethodPtr)(SPMySQLResult*, SEL, SPMySQLResultRowType);
+	static SPMySQLResultGetRowMethodPtr cachedMethodPointer;
+	static SEL cachedSelector;
+
+	if (!cachedSelector) cachedSelector = @selector(getRowAsType:);
+	if (!cachedMethodPointer) cachedMethodPointer = (SPMySQLResultGetRowMethodPtr)[self methodForSelector:cachedSelector];
+
+	return cachedMethodPointer(self, cachedSelector, rowType);
+}
\ No newline at end of file