64bit/Database/notes - Revision history

Dave at 17:04, 21 May 2020

2020-05-21T17:04:48Z

← Older revision		Revision as of 17:04, 21 May 2020
Line 11:		Line 11:
	meta data keys are four-char-code (UInt32) values which unfortunately you can't see in the debugger because [https://bugreports.qt.io/browse/QTCREATORBUG-22849?filter=-2 Qt doesn't have the facility for looking at four-char-code] values as chars :(		meta data keys are four-char-code (UInt32) values which unfortunately you can't see in the debugger because [https://bugreports.qt.io/browse/QTCREATORBUG-22849?filter=-2 Qt doesn't have the facility for looking at four-char-code] values as chars :(

	type: '''CM_KeyType'''<br>		type: '''CM_KeyType''', FourCC. Not to be confused with the ENUM SDB_KeyType, used in saving / loading old DB xml (plist) playlist files<br>
			synonymous with CDB_KeyType, which is UInt64, only used with certain APIs that need a 64bit "KeyType", top 32bits are zero. you probably won't interact with that.
	documented here: CMeta_p.h<br>		documented here: CMeta_p.h<br>
	each key corrisponds 1:1 with a "sort column" that may be shown in the table view		each key corrisponds 1:1 with a "sort column" that may be shown in the table view

Dave at 16:42, 21 May 2020

2020-05-21T16:42:04Z

← Older revision		Revision as of 16:42, 21 May 2020
Line 9:		Line 9:
	'''CMeta.h / CMetaManager''' class:<br>		'''CMeta.h / CMetaManager''' class:<br>
	high level manager of meta data, and meta-metadata (data traits)<br>		high level manager of meta data, and meta-metadata (data traits)<br>
	meta data keys are four-char-code (UInt32) values which unfortunately you can't see in the debugger because Qt doesn't have the facility for looking at four-char-code values as chars :(		meta data keys are four-char-code (UInt32) values which unfortunately you can't see in the debugger because [https://bugreports.qt.io/browse/QTCREATORBUG-22849?filter=-2 Qt doesn't have the facility for looking at four-char-code] values as chars :(

	type: '''CM_KeyType'''<br>		type: '''CM_KeyType'''<br>

Dave at 01:29, 21 May 2020

2020-05-21T01:29:44Z

Dave at 01:27, 21 May 2020

2020-05-21T01:27:58Z

Dave at 01:23, 21 May 2020

2020-05-21T01:23:43Z

← Older revision		Revision as of 01:23, 21 May 2020
Line 1:		Line 1:
	~~put your notes here!~~		a "browser" in our context is a "data (base) browser", which displays as a tree view or a table view
			"sources" is the list on the left in the main window (tree view)
			"tracks" is the list on the right (table view)
			when you select a "source", you see its contents in the "tracks" area

	~~test~~		"C" at the beginning of a class just means "class"
			"i_" at the beginning of a member variable name just means "instance variable"

			CMeta.h / CMetaManager class:
			high level manager of meta data, and meta-metadata (data traits)
			meta data keys are four-char-code (UInt32) values which unfortunately you can't see in the debugger because Qt doesn't
			have the facility for looking at four-char-code values as chars :(
			type: CM_KeyType
			documented here: CMeta_p.h
			each key corrisponds 1:1 with a "sort column" that may be shown in the table view

			CDB_Columns the class that manages the sort columns: order, insert / delete, save / restore etc
			use this as the ONLY method of accessing info about columns in a view
			to access traits info ABOUT a key (display name, type etc),
			use CData::GetTraits() if you have a CData object already
			or CMetaManager::GetTraits(keyType), returns same thing

			CDataBrowser
			abstract class for either tree or table view

			CDataBrowserItem
			object that represents a row in a table, or node in a tree
			has properties which can be looked up by CM_KeyType
			and each property may be of any data type (bool, int, float, date, menu etc)

			CDB_Callbacks.h / CDataBrowserCallbacks
			the abstract class that handles the callbacks (sortof like signal / slots)
			for the data browsers in kJams, in place since way before Qt
			we want to hook any signls that make sense so they come thru this class,
			as all sorts of triggers happen due to these callbacks
			CBrowser_Source.cpp: tree view abstract class
			CBrowser_Track.cpp: table view abstract class

			CDB_Mac, CDB_Win
			previous implementations of much of the above, at the edge of the platform API code
			see these two implementations for hints on how to implement the same functions on Qt

			CDB_Qt:
			the implementation we are creating. much of it is working, but you'll need to create some too

			CPlayList: class that manages a list of CPlayListItem's
			1:1 correspondence with everything you see in the Sources (tree view) panel

			CPlayListItem: a song, a singer, or a playlist.
			so yes, a playlist item can itself be a playlist (ie: parent contains a list of playlists)

			CPlayListProxyModel:
			look in here for what's been done so far: i'm not really sure how this works, so i'll need you to understand it

			CSearchManager:
			the search controller you will be hooking into
			currently supports accepting updated search string from search box, firing off a new search on a background thread,
			cancelling any underway search(es), and then displaying results once a search commpletes

			CSongDatabase:
			the high level manager (controller) of the database, as naïvely written by me. go thru this for access to songs or an individual song's meta data (not bulk stuff)

			CSong: a single song and it's meta data. you can get any meta from a song via i_metaP->GetAs_TYPE(), passing a key. this is already hooked into SQLite i think...

			SDB_Selection: manages selection, getting selection from view, setting selection in view, save/restore selection, iterating selection etc

			SDB_SaveLoad: old way of loading database
			still called to manage loading playlist info (which references items in the db)

			QBrowserWindow the window managing the views of the main window

			CApp::CApp() the main init point of the entire app, scan this for a gist of all the stuff in the start progress window that flashes by so fast
			when you start the app

			DynamicMenus.cpp a place to put unit tests you can pick from the debug menu, LMK if you want more info on that

			CSQL.cpp the lowest level wrapper around actual SQLite calls. there may be some bugs here or simply unimplemented stuff
			or inefficiently implemented stuff eg: CountRows() i think is pretty stupid: the older method was better? (code still there for reference)

			KJDatabase.cpp higher level controller for using SQLite in kJams, use this if you can, implement things in terms of what's in CSQL
			KJDatabase::KJDatabase() the place we actually

			KJDB_Load: loads an existing sql db, or creates a new one based on the old database.
			if you bork your DB, you can start fresh by just deleting the ".ksql" file in the "kJams Database" folder, then run kJams
			it will then re-load the previous (old) database and convert it to sqlite format

			KJDB_SearchSort: here is where your magic will happen. this old code was written prior to Qt, and is not connected up to anything, but is there for reference. feel free to use it as inspiration.

Davetest at 03:28, 2 August 2019

2019-08-02T03:28:20Z

← Older revision		Revision as of 03:28, 2 August 2019
Line 1:		Line 1:
	put your notes here!		put your notes here!

	test		test

Dave at 18:35, 22 February 2019

2019-02-22T18:35:21Z

← Older revision		Revision as of 18:35, 22 February 2019
Line 1:		Line 1:
	put your notes here!		put your notes here!
			test

Dave: Created page with "put your notes here!"

2019-02-21T21:36:32Z

Created page with "put your notes here!"

New page

put your notes here!

← Older revision		Revision as of 01:29, 21 May 2020
Line 7:		Line 7:
	"i_" at the beginning of a member variable name just means "instance variable"		"i_" at the beginning of a member variable name just means "instance variable"

	CMeta.h / CMetaManager class:<br>		'''CMeta.h / CMetaManager''' class:<br>
	high level manager of meta data, and meta-metadata (data traits)<br>		high level manager of meta data, and meta-metadata (data traits)<br>
	meta data keys are four-char-code (UInt32) values which unfortunately you can't see in the debugger because Qt doesn't have the facility for looking at four-char-code values as chars :(		meta data keys are four-char-code (UInt32) values which unfortunately you can't see in the debugger because Qt doesn't have the facility for looking at four-char-code values as chars :(

	type: CM_KeyType<br>		type: '''CM_KeyType'''<br>
	documented here: CMeta_p.h<br>		documented here: CMeta_p.h<br>
	each key corrisponds 1:1 with a "sort column" that may be shown in the table view		each key corrisponds 1:1 with a "sort column" that may be shown in the table view

	CDB_Columns the class that manages the sort columns: order, insert / delete, save / restore etc<br>		'''CDB_Columns''' the class that manages the sort columns: order, insert / delete, save / restore etc<br>
	use this as the ONLY method of accessing info about columns in a view<br>		use this as the ONLY method of accessing info about columns in a view<br>
	to access traits info ABOUT a key (display name, type etc), <br>		to access traits info ABOUT a key (display name, type etc), <br>
Line 21:		Line 21:
	or CMetaManager::GetTraits(keyType), returns same thing		or CMetaManager::GetTraits(keyType), returns same thing

	CDataBrowser<br>		'''CDataBrowser'''<br>
	abstract class for either tree or table view<br>		abstract class for either tree or table view<br>

	CDataBrowserItem<br>		'''CDataBrowserItem'''<br>
	object that represents a row in a table, or node in a tree<br>		object that represents a row in a table, or node in a tree<br>
	has properties which can be looked up by CM_KeyType<br>		has properties which can be looked up by CM_KeyType<br>
	and each property may be of any data type (bool, int, float, date, menu etc)		and each property may be of any data type (bool, int, float, date, menu etc)

	CDB_Callbacks.h / CDataBrowserCallbacks<br>		'''CDB_Callbacks.h / CDataBrowserCallbacks'''<br>
	the abstract class that handles the callbacks (sortof like signal / slots)<br>		the abstract class that handles the callbacks (sortof like signal / slots)<br>
	for the data browsers in kJams, in place since way before Qt<br>		for the data browsers in kJams, in place since way before Qt<br>
	we want to hook any signls that make sense so they come thru this class,<br>		we want to hook any signls that make sense so they come thru this class,<br>
	as all sorts of triggers happen due to these callbacks<br>		as all sorts of triggers happen due to these callbacks<br>
	CBrowser_Source.cpp: tree view abstract class<br>		'''CBrowser_Source.cpp''': tree view abstract class<br>
	CBrowser_Track.cpp: table view abstract class		'''CBrowser_Track.cpp''': table view abstract class

	CDB_Mac, CDB_Win<br>		'''CDB_Mac, CDB_Win'''<br>
	previous implementations of much of the above, at the edge of the platform API code<br>		previous implementations of much of the above, at the edge of the platform API code<br>
	see these two implementations for hints on how to implement the same functions on Qt		see these two implementations for hints on how to implement the same functions on Qt

	CDB_Qt:<br>		'''CDB_Qt''':<br>
	the implementation we are creating. much of it is working, but you'll need to create some too		the implementation we are creating. much of it is working, but you'll need to create some too

	CPlayList: class that manages a list of CPlayListItem's<br>		'''CPlayList''': class that manages a list of CPlayListItem's<br>
	1:1 correspondence with everything you see in the Sources (tree view) panel		1:1 correspondence with everything you see in the Sources (tree view) panel

	CPlayListItem: a song, a singer, or a playlist.<br>		'''CPlayListItem''': a song, a singer, or a playlist.<br>
	so yes, a playlist item can itself be a playlist (ie: parent contains a list of playlists)		so yes, a playlist item can itself be a playlist (ie: parent contains a list of playlists)

	CPlayListProxyModel:<br>		'''CPlayListProxyModel''':<br>
	look in here for what's been done so far: i'm not really sure how this works, so i'll need you to understand it		look in here for what's been done so far: i'm not really sure how this works, so i'll need you to understand it

	CSearchManager:<br>		'''CSearchManager''':<br>
	the search controller you will be hooking into<br>		the search controller you will be hooking into<br>
	currently supports accepting updated search string from search box, firing off a new search on a background thread, cancelling any underway search(es), and then displaying results once a search commpletes		currently supports accepting updated search string from search box, firing off a new search on a background thread, cancelling any underway search(es), and then displaying results once a search commpletes

	CSongDatabase:<br>		'''CSongDatabase''':<br>
	the high level manager (controller) of the database, as naïvely written by me. go thru this for access to songs or an individual song's meta data (not bulk stuff)		the high level manager (controller) of the database, as naïvely written by me. go thru this for access to songs or an individual song's meta data (not bulk stuff)

	CSong:<br>		'''CSong''':<br>
	a single song and it's meta data. you can get any meta from a song via i_metaP->GetAs_TYPE(), passing a key. this is already hooked into SQLite i think...		a single song and it's meta data. you can get any meta from a song via i_metaP->GetAs_TYPE(), passing a key. this is already hooked into SQLite i think...

	SDB_Selection:<br>		'''SDB_Selection''':<br>
	manages selection, getting selection from view, setting selection in view, save/restore selection, iterating selection etc		manages selection, getting selection from view, setting selection in view, save/restore selection, iterating selection etc

	SDB_SaveLoad:<br>		'''SDB_SaveLoad''':<br>
	old way of loading database<br>		old way of loading database<br>
	still called to manage loading playlist info (which references items in the db)		still called to manage loading playlist info (which references items in the db)

	QBrowserWindow:<br>		'''QBrowserWindow''':<br>
	the window managing the views of the main window		the window managing the views of the main window

	CApp::CApp() the main init point of the entire app, scan this for a gist of all the stuff in the start progress window that flashes by so fast when you start the app		'''CApp::CApp()''' the main init point of the entire app, scan this for a gist of all the stuff in the start progress window that flashes by so fast when you start the app

	DynamicMenus.cpp a place to put unit tests you can pick from the debug menu, LMK if you want more info on that		'''DynamicMenus.cpp''' a place to put unit tests you can pick from the debug menu, LMK if you want more info on that

	CSQL.cpp the lowest level wrapper around actual SQLite calls. there may be some bugs here or simply unimplemented stuff<br>		CSQL.cpp the lowest level wrapper around actual SQLite calls. there may be some bugs here or simply unimplemented stuff<br>
	or inefficiently implemented stuff eg: CountRows() i think is pretty stupid: the older method was better? (code still there for reference)		or inefficiently implemented stuff eg: CountRows() i think is pretty stupid: the older method was better? (code still there for reference)

	KJDatabase.cpp higher level controller for using SQLite in kJams, use this if you can, implement things in terms of what's in CSQL<br>		'''KJDatabase.cpp''' higher level controller for using SQLite in kJams, use this if you can, implement things in terms of what's in CSQL<br>

	KJDB_Load: loads an existing sql db, or creates a new one based on the old database. <br>		'''KJDB_Load''': loads an existing sql db, or creates a new one based on the old database. <br>
	if you bork your DB, you can start fresh by just deleting the ".ksql" file in the "kJams Database" folder, then run kJams<br>		if you bork your DB, you can start fresh by just deleting the ".ksql" file in the "kJams Database" folder, then run kJams<br>
	it will then re-load the previous (old) database and convert it to sqlite format		it will then re-load the previous (old) database and convert it to sqlite format

	KJDB_SearchSort:<br>		'''KJDB_SearchSort''':<br>
	here is where your magic will happen. this old code was written prior to Qt, and is not connected up to anything, but is there for reference. feel free to use it as inspiration.		here is where your magic will happen. this old code was written prior to Qt, and is not connected up to anything, but is there for reference. feel free to use it as inspiration.

← Older revision		Revision as of 01:27, 21 May 2020
Line 1:		Line 1:
	a "browser" in our context is a "data (base) browser", which displays as a tree view or a table view		a "browser" in our context is a "data (base) browser", which displays as a tree view or a table view<br>
	"sources" is the list on the left in the main window (tree view)		"sources" is the list on the left in the main window (tree view)<br>
	"tracks" is the list on the right (table view)		"tracks" is the list on the right (table view)<br>
	when you select a "source", you see its contents in the "tracks" area		when you select a "source", you see its contents in the "tracks" area

	"C" at the beginning of a class just means "class"		"C" at the beginning of a class just means "class"<br>
	"i_" at the beginning of a member variable name just means "instance variable"		"i_" at the beginning of a member variable name just means "instance variable"

	CMeta.h / CMetaManager class:		CMeta.h / CMetaManager class:<br>
	high level manager of meta data, and meta-metadata (data traits)		high level manager of meta data, and meta-metadata (data traits)<br>
	meta data keys are four-char-code (UInt32) values which unfortunately you can't see in the debugger because Qt doesn't		meta data keys are four-char-code (UInt32) values which unfortunately you can't see in the debugger because Qt doesn't have the facility for looking at four-char-code values as chars :(
	have the facility for looking at four-char-code values as chars :(
	type: CM_KeyType		type: CM_KeyType<br>
	documented here: CMeta_p.h		documented here: CMeta_p.h<br>
	each key corrisponds 1:1 with a "sort column" that may be shown in the table view		each key corrisponds 1:1 with a "sort column" that may be shown in the table view

	CDB_Columns the class that manages the sort columns: order, insert / delete, save / restore etc		CDB_Columns the class that manages the sort columns: order, insert / delete, save / restore etc<br>
	use this as the ONLY method of accessing info about columns in a view		use this as the ONLY method of accessing info about columns in a view<br>
	to access traits info ABOUT a key (display name, type etc),		to access traits info ABOUT a key (display name, type etc), <br>
	use CData::GetTraits() if you have a CData object already		use CData::GetTraits() if you have a CData object already<br>
	or CMetaManager::GetTraits(keyType), returns same thing		or CMetaManager::GetTraits(keyType), returns same thing

	CDataBrowser		CDataBrowser<br>
	abstract class for either tree or table view		abstract class for either tree or table view<br>

	CDataBrowserItem		CDataBrowserItem<br>
	object that represents a row in a table, or node in a tree		object that represents a row in a table, or node in a tree<br>
	has properties which can be looked up by CM_KeyType		has properties which can be looked up by CM_KeyType<br>
	and each property may be of any data type (bool, int, float, date, menu etc)		and each property may be of any data type (bool, int, float, date, menu etc)

	CDB_Callbacks.h / CDataBrowserCallbacks		CDB_Callbacks.h / CDataBrowserCallbacks<br>
	the abstract class that handles the callbacks (sortof like signal / slots)		the abstract class that handles the callbacks (sortof like signal / slots)<br>
	for the data browsers in kJams, in place since way before Qt		for the data browsers in kJams, in place since way before Qt<br>
	we want to hook any signls that make sense so they come thru this class,		we want to hook any signls that make sense so they come thru this class,<br>
	as all sorts of triggers happen due to these callbacks		as all sorts of triggers happen due to these callbacks<br>
	CBrowser_Source.cpp: tree view abstract class		CBrowser_Source.cpp: tree view abstract class<br>
	CBrowser_Track.cpp: table view abstract class		CBrowser_Track.cpp: table view abstract class

	CDB_Mac, CDB_Win		CDB_Mac, CDB_Win<br>
	previous implementations of much of the above, at the edge of the platform API code		previous implementations of much of the above, at the edge of the platform API code<br>
	see these two implementations for hints on how to implement the same functions on Qt		see these two implementations for hints on how to implement the same functions on Qt

	CDB_Qt:		CDB_Qt:<br>
	the implementation we are creating. much of it is working, but you'll need to create some too		the implementation we are creating. much of it is working, but you'll need to create some too

	CPlayList: class that manages a list of CPlayListItem's		CPlayList: class that manages a list of CPlayListItem's<br>
	1:1 correspondence with everything you see in the Sources (tree view) panel		1:1 correspondence with everything you see in the Sources (tree view) panel

	CPlayListItem: a song, a singer, or a playlist.		CPlayListItem: a song, a singer, or a playlist.<br>
	so yes, a playlist item can itself be a playlist (ie: parent contains a list of playlists)		so yes, a playlist item can itself be a playlist (ie: parent contains a list of playlists)

	CPlayListProxyModel:		CPlayListProxyModel:<br>
	look in here for what's been done so far: i'm not really sure how this works, so i'll need you to understand it		look in here for what's been done so far: i'm not really sure how this works, so i'll need you to understand it

	CSearchManager:		CSearchManager:<br>
	the search controller you will be hooking into		the search controller you will be hooking into<br>
	currently supports accepting updated search string from search box, firing off a new search on a background thread,		currently supports accepting updated search string from search box, firing off a new search on a background thread, cancelling any underway search(es), and then displaying results once a search commpletes
	cancelling any underway search(es), and then displaying results once a search commpletes

	CSongDatabase:		CSongDatabase:<br>
	the high level manager (controller) of the database, as naïvely written by me. go thru this for access to songs or an individual song's meta data (not bulk stuff)		the high level manager (controller) of the database, as naïvely written by me. go thru this for access to songs or an individual song's meta data (not bulk stuff)

	CSong: a single song and it's meta data. you can get any meta from a song via i_metaP->GetAs_TYPE(), passing a key. this is already hooked into SQLite i think...		CSong:<br>
			a single song and it's meta data. you can get any meta from a song via i_metaP->GetAs_TYPE(), passing a key. this is already hooked into SQLite i think...

	SDB_Selection: manages selection, getting selection from view, setting selection in view, save/restore selection, iterating selection etc		SDB_Selection:<br>
			manages selection, getting selection from view, setting selection in view, save/restore selection, iterating selection etc

	SDB_SaveLoad: old way of loading database		SDB_SaveLoad:<br>
			old way of loading database<br>
	still called to manage loading playlist info (which references items in the db)		still called to manage loading playlist info (which references items in the db)

	QBrowserWindow the window managing the views of the main window		QBrowserWindow:<br>
			the window managing the views of the main window

	CApp::CApp() the main init point of the entire app, scan this for a gist of all the stuff in the start progress window that flashes by so fast		CApp::CApp() the main init point of the entire app, scan this for a gist of all the stuff in the start progress window that flashes by so fast when you start the app
	when you start the app

	DynamicMenus.cpp a place to put unit tests you can pick from the debug menu, LMK if you want more info on that		DynamicMenus.cpp a place to put unit tests you can pick from the debug menu, LMK if you want more info on that

	CSQL.cpp the lowest level wrapper around actual SQLite calls. there may be some bugs here or simply unimplemented stuff		CSQL.cpp the lowest level wrapper around actual SQLite calls. there may be some bugs here or simply unimplemented stuff<br>
	or inefficiently implemented stuff eg: CountRows() i think is pretty stupid: the older method was better? (code still there for reference)		or inefficiently implemented stuff eg: CountRows() i think is pretty stupid: the older method was better? (code still there for reference)

	KJDatabase.cpp higher level controller for using SQLite in kJams, use this if you can, implement things in terms of what's in CSQL		KJDatabase.cpp higher level controller for using SQLite in kJams, use this if you can, implement things in terms of what's in CSQL<br>
	~~KJDatabase::KJDatabase() the place we actually~~

	KJDB_Load: loads an existing sql db, or creates a new one based on the old database.		KJDB_Load: loads an existing sql db, or creates a new one based on the old database. <br>
	if you bork your DB, you can start fresh by just deleting the ".ksql" file in the "kJams Database" folder, then run kJams		if you bork your DB, you can start fresh by just deleting the ".ksql" file in the "kJams Database" folder, then run kJams<br>
	it will then re-load the previous (old) database and convert it to sqlite format		it will then re-load the previous (old) database and convert it to sqlite format

	KJDB_SearchSort: here is where your magic will happen. this old code was written prior to Qt, and is not connected up to anything, but is there for reference. feel free to use it as inspiration.		KJDB_SearchSort:<br>
			here is where your magic will happen. this old code was written prior to Qt, and is not connected up to anything, but is there for reference. feel free to use it as inspiration.