// BOSS API// NOTES:// - This is just what I could tell that Wrye Bash needs to use for it's information.//   I'm sure more things may be useful to expose (the actual ordering stuff, etc).// - Need to think about unicode.  Best solution might be the 'Windows API way', with//   for example a 'ParseMasterlistA' and 'ParseMasterlistW' function both exported.//   I'm thinking encoding for the unicode versions would be UTF-8?  Or would UTF-16//   be better?  Encoding on the 'tags' variables can always be ASCII, the variables//   I see that would probably need to be unicode are://    ParseMasterlist   - masterlistPath//    ParseUserlist     - userlistPath//    GetBashTags       - modName//    GetBashRemoveTags - modName//    GetDirtyMessage   - message/* Initializing functions.  Parse the userlist and masterlist for data */bool ParseMasterlist(const char *masterlistPath=NULL);// masterlistPath: path to the masterlist.  If NULL, try the cwd.// return true if parsing successful, false otherwise.  Possibly use// more return codes to pass error information?// A second call to this would reparse the masterlist, updating with// new information.  An error on a reparse would not clear out old// masterlist information.bool ParseUserlist(const char *userlistPath=NULL);// userlistPath: path to userlist.  If NULL, try the cwd.// return true if parsing successful, false otherwise.  Possibly use// more return codes to pass error information?// A second call to this would reparse the userlist, updating with// new information.  An error on a reparse will clear out old// userlist information./* Get information for a specific mod */int GetBashTags(const char *modName, char **tags, unsigned int maxTags, unsigned int bufferSize);// modName: name of the modfile to get information for (not case sensitive)// tags: list of strings, allocated by the caller to hold resulting tags.// maxTags: max number of strings that 'tags' can hold.// bufferSize: max length (including NULL) of each string in 'tags'.// return: <0: indicates an error, otherwise, indicates the actual number of tags filled into 'tags'//// There might be a better way to pass this information around?int GetBashRemoveTags(const char *modName, char **tags, unsigned int maxTags, unsigned int bufferSize);// modName: name of the modfile to get information for (not case sensitive)// tags: list of strings, allocated by the caller to hold resulting tags.// maxTags: max number of strings that 'tags' can hold.// bufferSize: max length (including NULL) of each string in 'tags'.// return: <0: indicates an error, otherwise, indicates the actual number of tags filled into 'tags'bool GetDirtyMessage(long crc, char *message, unsigned int bufferSize);// crc: CRC of the mod to get the dirty message for// message: buffer to hold the message, caller allocated// bufferSize: max length of 'message'// return: true if there was a message for that crc, false if not.

#include #ifdef __cplusplusextern "C"{#endif//////////////////////////////// types// name is encoded in UTF-8 (though in practice it won't be more than ASCII)typedef struct{    uint32_t id;    char * name;} BashTag;// These are returned from the functions that return an // int.  We define error codes instead of error messages so// Wrye Bash can deal with the localizationconst uint32_t ERROR_SUCCESS = 0;const uint32_t ERROR_BAD_ARGUMENT = 1;const uint32_t ERROR_FILE_NOT_FOUND = 2;const uint32_t ERROR_FILE_ACCESS_DENIED = 3;const uint32_t ERROR_FILE_INVALID_SYNTAX = 4;const uint32_t ERROR_NO_MEM = 5;const uint32_t ERROR_INTERNAL = 6;//////////////////////////////// data definition functions// returns an array of BashTags and the number of tags in// the returned arrayvoid GetBashTagMap (BashTag ** map, uint32_t * numTags);////////////////////////////////////// lifecycle management functions// explicitly manage the lifetime of the database.  this// way we can free up the memory when we want/need to, like// when the user starts Oblivion and the system is low on// memory.uint32_t  CreateMasterlistDb  (void ** db);void DestroyMasterlistDb (void * db);/////////////////////////////////////// db loading functions.// can be called multiple times.  if masterlist is loaded,// then userlist is loaded, then masterlist is loaded// again, the previously-loaded userlist should still be// applied over the new masterlist.  path strings are in// UTF-8.  on error, database is expected to be unchanged.// path is case sensitive if the underlying file system is// case sensitiveuint32_t LoadMasterlist (void * db, const char * path);uint32_t LoadUserlist   (void * db, const char * path);/////////////////////////////////////// db access functions// returns an array of tagIds and the number of tags.  if// there are no tags, *tagIds can be NULL// modName is encoded in utf-8 and is not case sensitiveuint32_t GetModBashTags (void * db, const char * modName, uint32_t ** tagIds, uint32_t * numTags);// returns the message associated with a dirty mod and// whether the mod needs cleaning.  if a mod has no// dirty message, *message should be NULL.// modName is encoded in utf-8 and is not case sensitive// message, if not NULL, should be encoded in utf-8// needsCleaning://   0 == no//   1 == yes//   2 == unknownuint32_t GetDirtyMessage (void * db, const char * modName, uint32_t crc, char ** message, uint32_t * needsCleaning);#ifdef __cplusplus}#endif

• a 32-bit dll with a name that ends with "32", such as "boss32.dll" (so we can easily load the correct bit size dll once we offer both 32- and 64-bit)
  
• if it is convenient for you to build, a 64-bit dll with the same name, but with "64" instead of "32"
  
• dll should be deployed in the Oblivion/BOSS directory along with the BOSS executable (we might want to deploy a copy with Wrye Bash as well, in case the user doesn't have BOSS installed, so we can read our taglist.txt file, but at runtime we'd use the one deployed with BOSS if its there)
  
• The DLLs should have their version header populated (so we can figure out which of the DLLs is the more recent version and so we can change which functions we call based on which version it is, if necessary)
  
• Alternately, we could use BOSS-specific version retrieval functions (e.g. int GetBossMajorVersion(), int GetBossMinorVersion) if he has to provide them anyway for his own purposes

bool IsCompatible (uint32_t bossVersionMajor, uint32_t bossVersionMinor);uint32_t GetVersionString (char ** bossVersion); // for display

#include // writes a minimal masterlist that only contains mods// that have tags (plus the tags themselves) in order to create the// Wrye Bash taglist.txt file.  outputFile is a UTF-8 string specifying the// file to use for output.  outputFile can be overwritten if it exists iff// overwrite is trueuint32_t DumpTags (void * db, const char * outputFile, bool overwrite);

#include // writes a minimal masterlist that only contains mods// that have tags (plus the tags themselves) in order to create the// Wrye Bash taglist.txt file.  path strings are in UTF-8.uint32_t DumpTags (void * db, const char * path, bool overwrite);

	enum keyType {		NONE,		//Userlist keywords.		ADD,		OVERRIDE,		FOR,		BEFORE,		AFTER,		TOP,		BOTTOM,		APPEND,		REPLACE,		//Masterlist keywords.		SAY,		TAG,		REQ,		INC,		DIRTY,		WARN,		ERR,		//Legacy masterlist keywords.		OOOSAY,		BCSAY	};	enum itemType {		MOD,		BEGINGROUP,		ENDGROUP,		REGEX	};	struct message {		keyType key;		string data;	};	struct item {		itemType type;		fs::path name;		vector messages;	};	vector masterlist;

#include "BOSSAPI.h"static void _displayError (uint32_t err) { ... }void makeTagList (const char * masterlistPath, const char * taglistPath){    void * bossDb = NULL;    uint32_t err = CreateMasterlistDb(&db);    if (ERROR_SUCCESS != err)    {	_displayError(err);	return;    }    err = LoadMasterlist(db, masterlistPath);    if (ERROR_SUCCESS != err)    {	_displayError(err);	DestroyMasterlistDb(db);	return;    }    err = DumpTags(db, taglistPath, true);    if (ERROR_SUCCESS != err)    {	_displayError(err);    }    DestroyMasterlistDb(db);}