FMResultSet.swift 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490
  1. import Foundation
  2. import SQLite3
  3. public class FMResultSet : NSObject {
  4. var parentDB : FMDatabase?
  5. var statement : FMStatement?
  6. var shouldAutoClose = true
  7. var _columnNameToIndexMap : [String: Int32]?
  8. static func resultSet(withStatement:FMStatement, parentDatabase:FMDatabase, shouldAutoClose: Bool) -> FMResultSet {
  9. let rs = FMResultSet()
  10. rs.parentDB = parentDatabase
  11. rs.statement = withStatement
  12. rs.shouldAutoClose = shouldAutoClose
  13. assert(!rs.statement!._inUse)
  14. withStatement._inUse = true
  15. return rs
  16. }
  17. public override init() {
  18. }
  19. deinit {
  20. close()
  21. }
  22. public func close() {
  23. statement?.reset()
  24. statement = nil
  25. parentDB?.resultSetDidClose(resultSet: self)
  26. parentDB = nil
  27. }
  28. public func columnCount() -> Int32 {
  29. return sqlite3_column_count(statement?._statement);
  30. }
  31. @discardableResult public func next() throws -> Bool {
  32. let rc = try internalStep()
  33. return rc == SQLITE_ROW;
  34. }
  35. func internalStep() throws -> Int32 {
  36. let rc = sqlite3_step(statement?._statement);
  37. var err : NSError?
  38. // … stuff
  39. if (SQLITE_BUSY == rc || SQLITE_LOCKED == rc) {
  40. print("Database busy ", #function, #line, parentDB?._databasePath! as Any)
  41. print("Database busy");
  42. err = NSError(domain: "FMDatabase", code: Int(rc), userInfo: [NSLocalizedDescriptionKey: parentDB?.lastErrorMessage() ?? "Unknown"]);
  43. }
  44. else if (SQLITE_DONE == rc || SQLITE_ROW == rc) {
  45. // all is well, let's return.
  46. }
  47. else if (SQLITE_ERROR == rc) {
  48. err = parentDB?.lastError()
  49. print("Error calling sqlite3_step ", err as Any)
  50. }
  51. else if (SQLITE_MISUSE == rc) {
  52. // uh oh.
  53. print("Error calling sqlite3_step ", rc, sqlite3_errmsg(parentDB?.sqliteHandle()) as Any);
  54. if (parentDB != nil) {
  55. err = parentDB?.lastError()
  56. }
  57. else {
  58. // If 'next' or 'nextWithError' is called after the result set is closed,
  59. // we need to return the appropriate error.
  60. err = NSError(
  61. domain: "FMDatabase",
  62. code: Int(SQLITE_MISUSE),
  63. userInfo: [
  64. NSLocalizedDescriptionKey: "parentDB does not exist"
  65. ]
  66. )
  67. }
  68. }
  69. else {
  70. // wtf?
  71. print("Unknown error calling sqlite3_step ", rc, sqlite3_errmsg(parentDB?.sqliteHandle()) as Any);
  72. err = parentDB?.lastError()
  73. }
  74. if (rc != SQLITE_ROW && shouldAutoClose) {
  75. close()
  76. }
  77. if let err = err {
  78. throw FMDBError.sqlite3ErrorCode(Int32(err.code))
  79. }
  80. return rc
  81. }
  82. func hasAnotherRow() -> Bool {
  83. return sqlite3_errcode(parentDB?.sqliteHandle()) == SQLITE_ROW;
  84. }
  85. func string(_ columnIndex: Int32) -> String? {
  86. if (sqlite3_column_type(statement?._statement, columnIndex) == SQLITE_NULL || (columnIndex < 0) || columnIndex >= sqlite3_column_count(statement?._statement)) {
  87. return nil;
  88. }
  89. let c = sqlite3_column_text(statement?._statement, columnIndex)
  90. if (c == nil) {
  91. return nil;
  92. }
  93. return String.init(cString: c!);
  94. }
  95. func string(_ columnName: String) -> String? {
  96. let columnIndex = columnIndexForName(columnName)
  97. if (columnIndex >= 0) {
  98. return string(columnIndex)
  99. }
  100. return nil
  101. }
  102. func UTF8String(_ columnIndex: Int32) -> UnsafePointer<UInt8>! {
  103. if (sqlite3_column_type(statement?._statement, columnIndex) == SQLITE_NULL || (columnIndex < 0) || columnIndex >= sqlite3_column_count(statement?._statement)) {
  104. return nil;
  105. }
  106. return sqlite3_column_text(statement?._statement, columnIndex)
  107. }
  108. func UTF8String(_ columnName: String) -> UnsafePointer<UInt8>! {
  109. let columnIndex = columnIndexForName(columnName)
  110. if (columnIndex >= 0) {
  111. return UTF8String(columnIndex)
  112. }
  113. return nil
  114. }
  115. func longLongInt(_ columnIndex: Int32) -> Int64 {
  116. return sqlite3_column_int64(statement?._statement, columnIndex);
  117. }
  118. func longLongInt(_ columnName: String) -> Int64 {
  119. let columnIndex = columnIndexForName(columnName)
  120. if (columnIndex >= 0) {
  121. return longLongInt(columnIndex)
  122. }
  123. print("Could not find column index for \(columnName)")
  124. return 0
  125. }
  126. func unsignedLongLongInt(_ columnIndex: Int32) -> UInt64 {
  127. return UInt64(truncatingIfNeeded: sqlite3_column_int64(statement?._statement, columnIndex));
  128. }
  129. func unsignedLongLongInt(_ columnName: String) -> UInt64 {
  130. let columnIndex = columnIndexForName(columnName)
  131. if (columnIndex >= 0) {
  132. return unsignedLongLongInt(columnIndex)
  133. }
  134. print("Could not find column index for \(columnName)")
  135. return 0
  136. }
  137. func int(_ columnIndex: Int32) -> Int32 {
  138. return sqlite3_column_int(statement?._statement, columnIndex);
  139. }
  140. func int(_ columnName: String) -> Int32 {
  141. let columnIndex = columnIndexForName(columnName)
  142. if (columnIndex >= 0) {
  143. return int(columnIndex)
  144. }
  145. print("Could not find column index for \(columnName)")
  146. return 0
  147. }
  148. // FIXME: Should 'bool' be renamed to 'boolean'?
  149. func bool(_ columnIndex: Int32) -> Bool {
  150. return int(columnIndex) != 0
  151. }
  152. func bool(_ columnName: String) -> Bool {
  153. return int(columnName) != 0
  154. }
  155. func double(_ columnIndex: Int32) -> Double {
  156. return sqlite3_column_double(statement?._statement, columnIndex);
  157. }
  158. func double(_ columnName: String) -> Double {
  159. let columnIndex = columnIndexForName(columnName)
  160. if (columnIndex >= 0) {
  161. return double(columnIndex);
  162. }
  163. return 0.0
  164. }
  165. func date(_ columnIndex: Int32) -> NSDate? {
  166. if (sqlite3_column_type(statement?._statement, columnIndex) == SQLITE_NULL || (columnIndex < 0) || columnIndex >= sqlite3_column_count(statement?._statement)) {
  167. return nil;
  168. }
  169. #warning("need to check for date formatters in dateForColumnIndex?")
  170. // return [_parentDB hasDateFormatter] ? [_parentDB dateFromString:[self stringForColumnIndex:columnIndex]] : [NSDate dateWithTimeIntervalSince1970:[self doubleForColumnIndex:columnIndex]];
  171. return NSDate.init(timeIntervalSince1970: double(columnIndex))
  172. }
  173. func date(_ columnName: String) -> NSDate? {
  174. let columnIndex = columnIndexForName(columnName)
  175. if (columnIndex >= 0) {
  176. return date(columnIndex);
  177. }
  178. return nil
  179. }
  180. func data(_ columnIndex: Int32) -> Data? {
  181. if (sqlite3_column_type(statement?._statement, columnIndex) == SQLITE_NULL || (columnIndex < 0) || columnIndex >= sqlite3_column_count(statement?._statement)) {
  182. return nil;
  183. }
  184. let dataBuffer = sqlite3_column_blob(statement?._statement, columnIndex);
  185. let dataSize = sqlite3_column_bytes(statement?._statement, columnIndex);
  186. if (dataBuffer == nil) {
  187. return nil
  188. }
  189. let d = NSData(bytes:dataBuffer, length: Int(dataSize))
  190. return d as Data
  191. }
  192. func data(_ columnName: String) -> Data? {
  193. let columnIndex = columnIndexForName(columnName)
  194. if (columnIndex >= 0) {
  195. return data(columnIndex);
  196. }
  197. return nil
  198. }
  199. func dataNoCopy(_ columnIndex: Int32) -> Data? {
  200. if (sqlite3_column_type(statement?._statement, columnIndex) == SQLITE_NULL || (columnIndex < 0) || columnIndex >= sqlite3_column_count(statement?._statement)) {
  201. return nil;
  202. }
  203. let dataBuffer = sqlite3_column_blob(statement?._statement, columnIndex);
  204. let dataSize = sqlite3_column_bytes(statement?._statement, columnIndex);
  205. if (dataBuffer == nil) {
  206. return nil
  207. }
  208. guard let dataBufferPointer = UnsafeMutableRawPointer(mutating:dataBuffer) else { return nil }
  209. let d = NSData(bytesNoCopy: dataBufferPointer, length: Int(dataSize), freeWhenDone: false)
  210. return d as Data
  211. }
  212. func dataNoCopy(_ columnName: String) -> Data? {
  213. let columnIndex = columnIndexForName(columnName)
  214. if (columnIndex >= 0) {
  215. return dataNoCopy(columnIndex);
  216. }
  217. return nil
  218. }
  219. /*
  220. - (NSMutableDictionary *)columnNameToIndexMap {
  221. if (!_columnNameToIndexMap) {
  222. int columnCount = sqlite3_column_count([_statement statement]);
  223. _columnNameToIndexMap = [[NSMutableDictionary alloc] initWithCapacity:(NSUInteger)columnCount];
  224. int columnIndex = 0;
  225. for (columnIndex = 0; columnIndex < columnCount; columnIndex++) {
  226. [_columnNameToIndexMap setObject:[NSNumber numberWithInt:columnIndex]
  227. forKey:[[NSString stringWithUTF8String:sqlite3_column_name([_statement statement], columnIndex)] lowercaseString]];
  228. }
  229. }
  230. return _columnNameToIndexMap;
  231. }
  232. */
  233. func columnNameToIndexMap() -> Dictionary<String, Int32> {
  234. if (_columnNameToIndexMap == nil) {
  235. let columnCount = sqlite3_column_count(statement?._statement);
  236. _columnNameToIndexMap = Dictionary()
  237. var columnIndex = Int32(0);
  238. while (columnIndex < columnCount) {
  239. let c = sqlite3_column_name(statement?._statement, columnIndex)
  240. let s = String.init(cString: c!).lowercased()
  241. _columnNameToIndexMap?[s] = columnIndex
  242. columnIndex += 1
  243. }
  244. }
  245. return _columnNameToIndexMap ?? [:]
  246. }
  247. func columnIndexForName( _ columnName : String) -> Int32 {
  248. let lowerName = columnName.lowercased()
  249. let n = columnNameToIndexMap()[lowerName]
  250. if (n == nil) {
  251. print("Warning: I could not find the column named '" + columnName + "'.");
  252. }
  253. return Int32(n ?? -1)
  254. }
  255. func columnNameForIndex(_ columnIndex : Int32) -> String {
  256. let c = sqlite3_column_name(statement?._statement, columnIndex)
  257. return String.init(cString: c!)
  258. }
  259. func typeForColumn(_ columnName:String) -> Int32 {
  260. let columnIndex = columnIndexForName(columnName)
  261. if (columnIndex >= 0) {
  262. return sqlite3_column_type(statement?._statement, columnIndex);
  263. }
  264. return 0
  265. }
  266. func typeForColumnIndex(_ columnIndex:Int32) -> Int32 {
  267. return sqlite3_column_type(statement?._statement, columnIndex);
  268. }
  269. func columnIsNull(_ columnName:String) -> Bool {
  270. return columnIsNull(columnIndexForName(columnName))
  271. }
  272. func columnIsNull(_ columnIndex:Int32) -> Bool {
  273. if (columnIndex >= 0) {
  274. return sqlite3_column_type(statement?._statement, columnIndex) == SQLITE_NULL;
  275. }
  276. return false
  277. }
  278. subscript(columnIndex: Int32) -> Any? {
  279. var returnValue : Any?
  280. let columnType = sqlite3_column_type(statement?._statement, columnIndex);
  281. if (columnType == SQLITE_INTEGER) {
  282. returnValue = longLongInt(columnIndex)
  283. }
  284. else if (columnType == SQLITE_FLOAT) {
  285. returnValue = double(columnIndex)
  286. }
  287. else if (columnType == SQLITE_BLOB) {
  288. returnValue = data(columnIndex)
  289. }
  290. else {
  291. //default to a string for everything else
  292. returnValue = string(columnIndex)
  293. }
  294. // FMDB in ObjC returns NSNull here. But… do we really need to do that anymore?
  295. // if (returnValue == nil) {
  296. // returnValue = NSNull()
  297. // }
  298. return returnValue
  299. }
  300. subscript(columnName: String) -> Any? {
  301. let columnIndex = columnIndexForName(columnName)
  302. if (columnIndex < 0 || columnIndex >= sqlite3_column_count(statement?._statement)) {
  303. return nil
  304. }
  305. return self[columnIndex]
  306. }
  307. func resultDictionary() -> Dictionary<String, Any> {
  308. if (sqlite3_data_count(statement?._statement) > 0) {
  309. var dict = [String: Any]()
  310. // FIXME: why do we use sqlite3_column_count here, but sqlite3_data_count above? Maybe add a comment as to why?
  311. let columnCount = sqlite3_column_count(statement?._statement);
  312. var columnIndex = Int32(0);
  313. while (columnIndex < columnCount) {
  314. let name = columnNameForIndex(columnIndex)
  315. let objVale = self[name]
  316. dict[name] = objVale
  317. columnIndex = columnIndex + 1
  318. }
  319. return dict
  320. }
  321. return [:]
  322. }
  323. }