CollectionInterface: overrideMap = handle errors when parsing XML

Author: pryrt

src/Classes/OverrideMapUpdaterClass.cpp

@@ -66,12 +66,27 @@ OverrideMapUpdater::OverrideMapUpdater(void)
 		/*tinyxml2::XMLElement* pAssoc =*/ add_udl_assoc("nppexec.xml", "NppExec");
 	}
 	else {
-		// TODO: !!! NEED TO ADD ERROR CHECKING !!!
 		// load file and extract the main elements
-		/*tinyxml2::XMLError eResult =*/ pOverrideMapXML->LoadFile(sOverMapPath().c_str());
+		tinyxml2::XMLError eResult = pOverrideMapXML->LoadFile(sOverMapPath().c_str());
+		if(_xml_check_result(eResult, pOverrideMapXML, wsOverMapPath())) return;
+
 		pRoot = pOverrideMapXML->FirstChildElement("NotepadPlus");
+		if (!pRoot) {
+			_xml_check_result(tinyxml2::XML_ERROR_PARSING, pOverrideMapXML, wsOverMapPath());
+			return;
+		}
+
 		pFunctionList = pRoot->FirstChildElement("functionList");
+		if (!pFunctionList) {
+			_xml_check_result(tinyxml2::XML_ERROR_PARSING, pOverrideMapXML, wsOverMapPath());
+			return;
+		}
+
 		pAssociationMap = pFunctionList->FirstChildElement("associationMap");
+		if (!pAssociationMap) {
+			_xml_check_result(tinyxml2::XML_ERROR_PARSING, pOverrideMapXML, wsOverMapPath());
+			return;
+		}
 	}
 }
 
@@ -122,20 +137,6 @@ std::vector<tinyxml2::XMLElement*> OverrideMapUpdater::add_udl_assoc(std::map<st
 	return vpAssoc;
 }
 
-bool OverrideMapUpdater::experiment(void)
-{
-	add_udl_assoc("fake.xml", "FakeUDL");
-	std::map<std::wstring, std::wstring> myMap = {
-		{L"udl1.xml", L"UDL 1"},
-		{L"udl2.xml", L"UDL 2"},
-		{L"udl3.xml", L"UDL 3"}
-	};
-	add_udl_assoc(myMap);
-	pOverrideMapXML->SaveFile(sOverMapPath().c_str());
-
-	return true;
-}
-
 // private: case-insensitive std::string equality check
 bool _string_insensitive_eq(std::string a, std::string b)
 {
@@ -194,3 +195,44 @@ tinyxml2::XMLElement* OverrideMapUpdater::_find_element_with_attribute_value(tin
 	}
 	return pFoundElement;
 }
+
+
+// compares the XMLError result to XML_SUCCESS, and returns a TRUE boolean to indicate failure
+//		p_doc defaults to nullptr, wsFilePath to L""
+bool OverrideMapUpdater::_xml_check_result(tinyxml2::XMLError a_eResult, tinyxml2::XMLDocument* p_doc, std::wstring wsFilePath)
+{
+	if (a_eResult != tinyxml2::XML_SUCCESS) {
+		std::string sMsg = std::string("XML Error #") + std::to_string(static_cast<int>(a_eResult));
+		if (p_doc != NULL) {
+			sMsg += std::string(": ") + std::string(p_doc->ErrorStr());
+			if (p_doc->ErrorLineNum()) {
+				sMsg += "\n\nI will try to open the file near that error.";
+			}
+		}
+		::MessageBoxA(NULL, sMsg.c_str(), "XML Error", MB_ICONWARNING | MB_OK);
+		if (p_doc != NULL && p_doc->ErrorLineNum() && wsFilePath.size()) {
+			if (::SendMessage(gNppMetaInfo.hwnd._nppHandle, NPPM_DOOPEN, 0, reinterpret_cast<LPARAM>(wsFilePath.c_str()))) {
+				extern NppData nppData;	// not in PluginDefinition.h
+
+				// Get the current scintilla
+				int which = -1;
+				::SendMessage(nppData._nppHandle, NPPM_GETCURRENTSCINTILLA, 0, (LPARAM)&which);
+				HWND curScintilla = (which < 1) ? nppData._scintillaMainHandle : nppData._scintillaSecondHandle;
+
+				// SCI_GOTOLINE in the current scintilla instance
+				WPARAM zeroLine = static_cast<WPARAM>(p_doc->ErrorLineNum() - 1);
+				::SendMessage(curScintilla, SCI_GOTOLINE, zeroLine, 0);
+
+				// do annotation
+				::SendMessage(curScintilla, SCI_ANNOTATIONCLEARALL, 0, 0);
+				::SendMessage(curScintilla, SCI_ANNOTATIONSETVISIBLE, ANNOTATION_BOXED, 0);
+				::SendMessageA(curScintilla, SCI_ANNOTATIONSETTEXT, zeroLine, reinterpret_cast<LPARAM>(p_doc->ErrorStr()));
+
+				// need to stop
+				// TODO: DO I NEED?? _doAbort = true;
+			};
+		}
+		return true;
+	}
+	return false;
+};

src/Classes/OverrideMapUpdaterClass.h

@@ -17,9 +17,6 @@ class OverrideMapUpdater {
 	// Instantiate OverrideMapUpdater object
 	OverrideMapUpdater(void);
 
-	// Experiment with concepts needed, might eventually morph into actual behavior
-	bool experiment(void);
-
 	// add an <association> tag for a given UDL
 	tinyxml2::XMLElement* OverrideMapUpdater::add_udl_assoc(std::wstring wsFilename, std::wstring wsUDLname);
 	tinyxml2::XMLElement* OverrideMapUpdater::add_udl_assoc(std::string sFilename, std::string sUDLname);
@@ -48,6 +45,10 @@ class OverrideMapUpdater {
 	// look for an element, based on {Parent, FirstChild, or both} which is of a specific ElementType, having a specific AttributeName with specific AttributeValue
 	tinyxml2::XMLElement* _find_element_with_attribute_value(tinyxml2::XMLElement* pParent, tinyxml2::XMLElement* pFirst, std::string sElementType, std::string sAttributeName, std::string sAttributeValue, bool caseSensitive);
 
+	// compares the XMLError result to XML_SUCCESS, and returns a TRUE boolean to indicate failure
+	//		p_doc defaults to nullptr, wsFilePath to L""
+	bool OverrideMapUpdater::_xml_check_result(tinyxml2::XMLError a_eResult, tinyxml2::XMLDocument* p_doc = nullptr, std::wstring wsFilePath = std::wstring(L""));
+
 	////////////////
 	// properties
 	////////////////

src/PluginDefinition.cpp

@@ -75,10 +75,9 @@ void commandMenuInit()
     //            bool check0nInit                // optional. Make this menu item be checked visually
     //            );
     setCommand(0, TEXT("Collection Interface: Download"), showCollectionInterface, NULL, false);
-    setCommand(1, TEXT("Collection Interface:: Experiment"), hello, NULL, false);
-    setCommand(2, TEXT("Help: Download"), showCIDownloadHelp, NULL, false);
-    setCommand(3, TEXT(""), NULL, NULL, false);
-    setCommand(4, TEXT("About"), showAboutModal, NULL, false);
+    setCommand(1, TEXT("Help: Download"), showCIDownloadHelp, NULL, false);
+    setCommand(2, TEXT(""), NULL, NULL, false);
+    setCommand(3, TEXT("About"), showAboutModal, NULL, false);
 }
 
 //
@@ -114,8 +113,6 @@ bool setCommand(size_t index, TCHAR *cmdName, PFUNCPLUGINCMD pFunc, ShortcutKey
 //----------------------------------------------//
 void hello()
 {
-    OverrideMapUpdater overMapUpdater;
-    overMapUpdater.experiment();
 }
 
 void helloDlg()

src/PluginDefinition.h

@@ -38,7 +38,7 @@ const TCHAR NPP_PLUGIN_NAME[] = TEXT("CollectionInterface");
 //
 // Here define the number of your plugin commands
 //
-const int nbFunc = 5;
+const int nbFunc = 4;
 
 
 //