Split vtab module in two.

A part specific to int array module.
And a generic part.
This commit is contained in:
gwenn 2016-02-03 20:11:34 +01:00
parent effbf1e395
commit 2dc4230223
2 changed files with 196 additions and 195 deletions

184
src/vtab/int_array.rs Normal file
View File

@ -0,0 +1,184 @@
//! Int array virtual table.
use std::error::Error as StdError;
use std::cell::RefCell;
use std::default::Default;
use std::mem;
use std::rc::Rc;
use libc;
use {Connection, Error, Result};
use ffi;
use functions::ToResult;
use vtab::{declare_vtab, mprintf};
pub fn create_int_array(conn: &Connection, name: &str) -> Result<Rc<RefCell<Vec<i64>>>> {
let array = Rc::new(RefCell::new(Vec::new()));
try!(conn.create_module(name, &INT_ARRAY_MODULE, array.clone()));
try!(conn.execute_batch(&format!("CREATE VIRTUAL TABLE temp.{0} USING {0}",
escape_quote(name.to_string()))));
Ok(array)
}
pub fn drop_int_array(conn: &Connection, name: &str) -> Result<()> {
conn.execute_batch(&format!("DROP TABLE temp.{0}", escape_quote(name.to_string())))
}
fn escape_quote(identifier: String) -> String {
if identifier.contains('"') {
// escape quote by doubling them
identifier.replace('"', "\"\"")
} else {
identifier
}
}
init_module!(INT_ARRAY_MODULE, IntArrayVTab, IntArrayVTabCursor,
int_array_create, int_array_best_index, int_array_destroy,
int_array_open, int_array_close,
int_array_filter, int_array_next, int_array_eof,
int_array_column, int_array_rowid);
#[repr(C)]
struct IntArrayVTab {
/// Base class
base: ffi::sqlite3_vtab,
array: *const Rc<RefCell<Vec<i64>>>,
}
impl IntArrayVTab {
fn create(db: *mut ffi::sqlite3,
aux: *mut libc::c_void,
_argc: libc::c_int,
_argv: *const *const libc::c_char)
-> Result<IntArrayVTab> {
let array = unsafe { mem::transmute(aux) };
let vtab = IntArrayVTab {
base: Default::default(),
array: array,
};
try!(declare_vtab(db, "CREATE TABLE x(value INTEGER PRIMARY KEY)"));
Ok(vtab)
}
fn best_index(&self, _info: *mut ffi::sqlite3_index_info) {
}
fn open(&self) -> IntArrayVTabCursor {
IntArrayVTabCursor::new()
}
}
#[repr(C)]
struct IntArrayVTabCursor {
/// Base class
base: ffi::sqlite3_vtab_cursor,
/// Current cursor position
i: usize,
}
impl IntArrayVTabCursor {
fn new() -> IntArrayVTabCursor {
IntArrayVTabCursor {
base: Default::default(),
i: 0,
}
}
fn vtab(&self) -> *mut IntArrayVTab {
self.base.pVtab as *mut IntArrayVTab
}
fn filter(&mut self) -> libc::c_int {
self.i = 0;
ffi::SQLITE_OK
}
fn next(&mut self) -> libc::c_int {
self.i = self.i + 1;
ffi::SQLITE_OK
}
fn eof(&self) -> bool {
let vtab = self.vtab();
unsafe {
let array = (*(*vtab).array).borrow();
self.i >= array.len()
}
}
fn column(&self, ctx: *mut ffi::sqlite3_context, _i: libc::c_int) -> libc::c_int {
let vtab = self.vtab();
unsafe {
let array = (*(*vtab).array).borrow();
array[self.i].set_result(ctx);
}
ffi::SQLITE_OK
}
fn rowid(&self) -> i64 {
self.i as i64
}
}
#[cfg(test)]
mod test {
use Connection;
use vtab::int_array;
#[test]
#[cfg_attr(rustfmt, rustfmt_skip)]
fn test_int_array_module() {
let db = Connection::open_in_memory().unwrap();
db.execute_batch("CREATE TABLE t1 (x INT);
INSERT INTO t1 VALUES (1), (3);
CREATE TABLE t2 (y INT);
INSERT INTO t2 VALUES (11);
CREATE TABLE t3 (z INT);
INSERT INTO t3 VALUES (-5);").unwrap();
let p1 = int_array::create_int_array(&db, "ex1").unwrap();
let p2 = int_array::create_int_array(&db, "ex2").unwrap();
let p3 = int_array::create_int_array(&db, "ex3").unwrap();
let mut s = db.prepare("SELECT * FROM t1, t2, t3
WHERE t1.x IN ex1
AND t2.y IN ex2
AND t3.z IN ex3").unwrap();
p1.borrow_mut().append(&mut vec![1, 2, 3, 4]);
p2.borrow_mut().append(&mut vec![5, 6, 7, 8, 9, 10, 11]);
p3.borrow_mut().append(&mut vec![-1, -5, -10]);
{
let rows = s.query(&[]).unwrap();
for row in rows {
let row = row.unwrap();
let i1: i64 = row.get(0);
assert!(i1 == 1 || i1 == 3);
assert_eq!(11, row.get(1));
assert_eq!(-5, row.get(2));
}
}
s.reset_if_needed();
p1.borrow_mut().clear();
p2.borrow_mut().clear();
p3.borrow_mut().clear();
p1.borrow_mut().append(&mut vec![1]);
p2.borrow_mut().append(&mut vec![7, 11]);
p3.borrow_mut().append(&mut vec![-5, -10]);
{
let row = s.query(&[]).unwrap().next().unwrap().unwrap();
assert_eq!(1, row.get(0));
assert_eq!(11, row.get(1));
assert_eq!(-5, row.get(2));
}
s.reset_if_needed();
p2.borrow_mut().clear();
p3.borrow_mut().clear();
p2.borrow_mut().append(&mut vec![3, 4, 5]);
p3.borrow_mut().append(&mut vec![0, -5]);
assert!(s.query(&[]).unwrap().next().is_none());
int_array::drop_int_array(&db, "ex1").unwrap();
int_array::drop_int_array(&db, "ex2").unwrap();
int_array::drop_int_array(&db, "ex3").unwrap();
}
}

View File

@ -1,17 +1,13 @@
//! Create virtual tables.
//! (See http://sqlite.org/vtab.html)
use std::cell::RefCell;
use std::default::Default;
use std::error::Error as StdError;
use std::ffi::CString;
use std::mem;
use std::rc::Rc;
use libc;
use {Connection, Error, Result, InnerConnection, str_to_cstring};
use error::error_from_sqlite_code;
use ffi;
use functions::ToResult;
// let conn: Connection = ...;
// let mod: Module = ...; // VTab builder
@ -73,32 +69,21 @@ impl InnerConnection {
}
}
pub fn declare_vtab(db: *mut ffi::sqlite3, sql: &str) -> Result<()> {
let c_sql = try!(CString::new(sql));
let rc = unsafe { ffi::sqlite3_declare_vtab(db, c_sql.as_ptr()) };
if rc == ffi::SQLITE_OK {
Ok(())
} else {
Err(error_from_sqlite_code(rc, None))
}
}
// FIXME copy/paste from function.rs
unsafe extern "C" fn free_boxed_value<T>(p: *mut libc::c_void) {
let _: Box<T> = Box::from_raw(mem::transmute(p));
}
pub fn create_int_array(conn: &Connection, name: &str) -> Result<Rc<RefCell<Vec<i64>>>> {
let array = Rc::new(RefCell::new(Vec::new()));
try!(conn.create_module(name, &INT_ARRAY_MODULE, array.clone()));
try!(conn.execute_batch(&format!("CREATE VIRTUAL TABLE temp.{0} USING {0}",
escape_quote(name.to_string()))));
Ok(array)
}
pub fn drop_int_array(conn: &Connection, name: &str) -> Result<()> {
conn.execute_batch(&format!("DROP TABLE temp.{0}", escape_quote(name.to_string())))
}
fn escape_quote(identifier: String) -> String {
if identifier.contains('"') {
// escape quote by doubling them
identifier.replace('"', "\"\"")
} else {
identifier
}
}
#[macro_export]
macro_rules! init_module {
($module_name: ident, $vtab: ident, $cursor: ty,
@ -224,109 +209,6 @@ unsafe extern "C" fn $rowid(cursor: *mut ffi::sqlite3_vtab_cursor,
}
}
init_module!(INT_ARRAY_MODULE, IntArrayVTab, IntArrayVTabCursor,
int_array_create, int_array_best_index, int_array_destroy,
int_array_open, int_array_close,
int_array_filter, int_array_next, int_array_eof,
int_array_column, int_array_rowid);
#[repr(C)]
struct IntArrayVTab {
/// Base class
base: ffi::sqlite3_vtab,
array: *const Rc<RefCell<Vec<i64>>>,
}
impl IntArrayVTab {
fn create(db: *mut ffi::sqlite3,
aux: *mut libc::c_void,
_argc: libc::c_int,
_argv: *const *const libc::c_char)
-> Result<IntArrayVTab> {
let array = unsafe { mem::transmute(aux) };
let vtab = IntArrayVTab {
base: Default::default(),
array: array,
};
try!(IntArrayVTab::declare_vtab(db, "CREATE TABLE x(value INTEGER PRIMARY KEY)"));
Ok(vtab)
}
fn declare_vtab(db: *mut ffi::sqlite3, sql: &str) -> Result<()> {
let c_sql = try!(CString::new(sql));
let rc = unsafe { ffi::sqlite3_declare_vtab(db, c_sql.as_ptr()) };
if rc == ffi::SQLITE_OK {
Ok(())
} else {
Err(error_from_sqlite_code(rc, None))
}
}
fn best_index(&self, _info: *mut ffi::sqlite3_index_info) {
// unimplemented!()
}
fn open(&self) -> IntArrayVTabCursor {
IntArrayVTabCursor::new()
}
fn set_err_msg(&mut self, err_msg: &str) {
if !self.base.zErrMsg.is_null() {
unsafe {
ffi::sqlite3_free(self.base.zErrMsg as *mut libc::c_void);
}
}
self.base.zErrMsg = mprintf(err_msg);
}
}
#[repr(C)]
struct IntArrayVTabCursor {
/// Base class
base: ffi::sqlite3_vtab_cursor,
/// Current cursor position
i: usize,
}
impl IntArrayVTabCursor {
fn new() -> IntArrayVTabCursor {
IntArrayVTabCursor {
base: Default::default(),
i: 0,
}
}
fn vtab(&self) -> *mut IntArrayVTab {
self.base.pVtab as *mut IntArrayVTab
}
fn filter(&mut self) -> libc::c_int {
self.i = 0;
ffi::SQLITE_OK
}
fn next(&mut self) -> libc::c_int {
self.i = self.i + 1;
ffi::SQLITE_OK
}
fn eof(&self) -> bool {
let vtab = self.vtab();
unsafe {
let array = (*(*vtab).array).borrow();
self.i >= array.len()
}
}
fn column(&self, ctx: *mut ffi::sqlite3_context, _i: libc::c_int) -> libc::c_int {
let vtab = self.vtab();
unsafe {
let array = (*(*vtab).array).borrow();
array[self.i].set_result(ctx);
}
ffi::SQLITE_OK
}
fn rowid(&self) -> i64 {
self.i as i64
}
}
unsafe fn result_error(ctx: *mut ffi::sqlite3_context, err: Error) -> libc::c_int {
match err {
Error::SqliteFailure(err, s) => {
@ -347,75 +229,10 @@ unsafe fn result_error(ctx: *mut ffi::sqlite3_context, err: Error) -> libc::c_in
}
// Space to hold this error message string must be obtained from an SQLite memory allocation function.
fn mprintf(err_msg: &str) -> *mut ::libc::c_char {
pub fn mprintf(err_msg: &str) -> *mut ::libc::c_char {
let c_format = CString::new("%s").unwrap();
let c_err = CString::new(err_msg).unwrap();
unsafe { ffi::sqlite3_mprintf(c_format.as_ptr(), c_err.as_ptr()) }
}
#[cfg(test)]
mod test {
use Connection;
use vtab;
#[test]
#[cfg_attr(rustfmt, rustfmt_skip)]
fn test_int_array_module() {
let db = Connection::open_in_memory().unwrap();
db.execute_batch("CREATE TABLE t1 (x INT);
INSERT INTO t1 VALUES (1), (3);
CREATE TABLE t2 (y INT);
INSERT INTO t2 VALUES (11);
CREATE TABLE t3 (z INT);
INSERT INTO t3 VALUES (-5);").unwrap();
let p1 = vtab::create_int_array(&db, "ex1").unwrap();
let p2 = vtab::create_int_array(&db, "ex2").unwrap();
let p3 = vtab::create_int_array(&db, "ex3").unwrap();
let mut s = db.prepare("SELECT * FROM t1, t2, t3
WHERE t1.x IN ex1
AND t2.y IN ex2
AND t3.z IN ex3").unwrap();
p1.borrow_mut().append(&mut vec![1, 2, 3, 4]);
p2.borrow_mut().append(&mut vec![5, 6, 7, 8, 9, 10, 11]);
p3.borrow_mut().append(&mut vec![-1, -5, -10]);
{
let rows = s.query(&[]).unwrap();
for row in rows {
let row = row.unwrap();
let i1: i64 = row.get(0);
assert!(i1 == 1 || i1 == 3);
assert_eq!(11, row.get(1));
assert_eq!(-5, row.get(2));
}
}
s.reset_if_needed();
p1.borrow_mut().clear();
p2.borrow_mut().clear();
p3.borrow_mut().clear();
p1.borrow_mut().append(&mut vec![1]);
p2.borrow_mut().append(&mut vec![7, 11]);
p3.borrow_mut().append(&mut vec![-5, -10]);
{
let row = s.query(&[]).unwrap().next().unwrap().unwrap();
assert_eq!(1, row.get(0));
assert_eq!(11, row.get(1));
assert_eq!(-5, row.get(2));
}
s.reset_if_needed();
p2.borrow_mut().clear();
p3.borrow_mut().clear();
p2.borrow_mut().append(&mut vec![3, 4, 5]);
p3.borrow_mut().append(&mut vec![0, -5]);
assert!(s.query(&[]).unwrap().next().is_none());
vtab::drop_int_array(&db, "ex1").unwrap();
vtab::drop_int_array(&db, "ex2").unwrap();
vtab::drop_int_array(&db, "ex3").unwrap();
}
}
pub mod int_array;