From bfe1bd0fc087be44c70904aee0fe4276643d206d Mon Sep 17 00:00:00 2001
From: George Hazan <george.hazan@gmail.com>
Date: Fri, 20 Jul 2012 15:56:25 +0000
Subject: - db3x_mmap is completely moved to a class; - the old nightmare in
 the core "How to detect a db plugin and load it" is eliminated forever; -
 databases are the usual plugins now (loadable via Load) - dynamic
 DATABASELINK registration

git-svn-id: http://svn.miranda-ng.org/main/trunk@1082 1316c22d-e87f-b044-9b9b-93d7a3e3ba9c
---
 include/m_db_int.h | 58 ++++++++++++++++++++++++++++++++----------------------
 1 file changed, 35 insertions(+), 23 deletions(-)

(limited to 'include/m_db_int.h')

diff --git a/include/m_db_int.h b/include/m_db_int.h
index f666ffcbd5..2fd70ceec5 100644
--- a/include/m_db_int.h
+++ b/include/m_db_int.h
@@ -66,33 +66,22 @@ interface MIDatabase
 	STDMETHOD_(BOOL,EnumResidentSettings)(DBMODULEENUMPROC pFunc, void *pParam) PURE;
 };
 
-typedef struct {
-	int cbSize;
-
-	/*
-	returns what the driver can do given the flag
-	*/
-	int (*getCapability) (int flag);
+///////////////////////////////////////////////////////////////////////////////
+// Each database plugin should register itself using this structure
 
-	/*
-		buf: pointer to a string buffer
-		cch: length of buffer
-		shortName: if true, the driver should return a short but descriptive name, e.g. "3.xx profile"
-		Affect: The database plugin must return a "friendly name" into buf and not exceed cch bytes,
-			e.g. "Database driver for 3.xx profiles"
-		Returns: 0 on success, non zero on failure
-	*/
-	int (*getFriendlyName) (TCHAR *buf, size_t cch, int shortName);
+struct DATABASELINK
+{
+	int cbSize;
+	char* szShortName;  // uniqie short database name
+	TCHAR* szFullName;  // in English, auto-translated by the core
 
 	/*
 		profile: pointer to a string which contains full path + name
 		Affect: The database plugin should create the profile, the filepath will not exist at
 			the time of this call, profile will be C:\..\<name>.dat
-		Note: Do not prompt the user in anyway about this operation.
-		Note: Do not initialise internal data structures at this point!
 		Returns: 0 on success, non zero on failure - error contains extended error information, see EMKPRF_*
 	*/
-	int (*makeDatabase) (TCHAR *profile, int * error);
+	int (*makeDatabase)(const TCHAR *profile, int *error);
 
 	/*
 		profile: [in] a null terminated string to file path of selected profile
@@ -104,22 +93,45 @@ typedef struct {
 			etc.
 		Returns: 0 on success, non zero on failure
 	*/
-	int (*grokHeader) (TCHAR *profile, int * error);
+	int (*grokHeader)(const TCHAR *profile, int * error);
 
 	/*
 	Affect: Tell the database to create all services/hooks that a 3.xx legecy database might support into link,
 		which is a PLUGINLINK structure
 	Returns: 0 on success, nonzero on failure
 	*/
-	MIDatabase* (*Load) (TCHAR *profile);
+	MIDatabase* (*Load) (const TCHAR *profile);
 
 	/*
 	Affect: The database plugin should shutdown, unloading things from the core and freeing internal structures
 	Returns: 0 on success, nonzero on failure
 	Note: Unload() might be called even if Load(void) was never called, wasLoaded is set to 1 if Load(void) was ever called.
 	*/
-	int (*Unload) (int wasLoaded);
+	int (*Unload)(MIDatabase*);
+};
+
+///////////////////////////////////////////////////////////////////////////////
+// Database list's services
+
+// MS_DB_REGISTER_PLUGIN : registers a database plugin
+// wParam : 0 (unused)
+// lParam : DATABASELINK* = database link description
+
+#define MS_DB_REGISTER_PLUGIN "DB/RegisterPlugin"
+
+__inline static void RegisterDatabasePlugin(DATABASELINK* pDescr)
+{	CallService(MS_DB_REGISTER_PLUGIN, 0, (LPARAM)pDescr);
+}
+
+// MS_DB_FIND_PLUGIN : looks for a database plugin suitable to open this file
+// wParam : 0 (unused)
+// lParam : const TCHAR* = name of the database file
+// returns DATABASELINK* of the required plugin or NULL on error
+
+#define MS_DB_FIND_PLUGIN "DB/FindPlugin"
 
-} DATABASELINK;
+__inline static DATABASELINK* FindDatabasePlugin(const TCHAR* ptszFileName)
+{	return (DATABASELINK*)CallService(MS_DB_FIND_PLUGIN, 0, (LPARAM)ptszFileName);
+}
 
 #endif // M_DB_INT_H__
-- 
cgit v1.2.3