Custom labels for MSHTML #6619

ManshulBelani · 2016-12-06T07:29:43Z

Assigning and accessing custom labels to web page components (form fields, links and graphics)

Issue #5874

…fields

…owse mode

… is not present in HTML

…ating in focus mode and browse mode.

…d form fields)

…wse mode

feerrenrut · 2016-12-30T04:44:23Z

@jcsteh It looks like this one would be best handled by you. See issue #5874

michaelDCurran

Apart from all other comments here, also please fix up your braces so that they conform to the same c++ coding style already in the files. I.e. opening brace at the end of the if statement line, closing and opening braces on same line as the else etc.

michaelDCurran · 2017-01-16T23:48:52Z

nvdaHelper/interfaces/vbuf/vbuf.idl

@@ -48,7 +48,7 @@ interface VBuf {
 * @param backendName The name of the backend (the path to the correct dll will be calculated automatically)
 * @return a handle identifying the new virtual buffer.
 */
-	VBufRemote_bufferHandle_t createBuffer([in] handle_t bindingHandle, [in] int docHandle, [in] int ID, [in,string] const wchar_t* backendName);
+	VBufRemote_bufferHandle_t createBuffer([in] handle_t bindingHandle, [in] int docHandle, [in] int ID, [in,string] const wchar_t* backendName,[in,string] const wchar_t* labels);


Update the code documentation above this method to mention the new argument.

michaelDCurran · 2017-01-17T00:02:12Z

nvdaHelper/vbufBackends/mshtml/mshtml.cpp

@@ -1072,6 +1075,7 @@ if(!(formatState&FORMATSTATE_INSERTED)&&nodeName.compare(L"INS")==0) {
 				// There is alt text, so use it.
 				contentString = tempIter->second;
 			}
+


accidentally added blank line.

michaelDCurran · 2017-01-17T00:05:54Z

nvdaHelper/vbufBackends/mshtml/mshtml.cpp

-		} 
+		}
+		if ((tempIter = attribsMap.find(L"HTMLAttrib::src")) != attribsMap.end()) {
+			renderChildren=true;


Why does renderChildren have to get set to true here?

michaelDCurran · 2017-01-17T00:09:41Z

nvdaHelper/vbufBackends/mshtml/mshtml.cpp

@@ -1140,7 +1163,33 @@ if(!(formatState&FORMATSTATE_INSERTED)&&nodeName.compare(L"INS")==0) {
 		attribsMap.find(L"HTMLAttrib::aria-label") != attribsMap.end() || attribsMap.find(L"HTMLAttrib::aria-labelledby") != attribsMap.end()
 		|| attribsMap.find(L"HTMLAttrib::title") != attribsMap.end() || attribsMap.find(L"HTMLAttrib::alt") != attribsMap.end()
 	)))
-		attribsMap[L"name"]=IAName;
+		{attribsMap[L"name"]=IAName;


Place the left brace ({) on the line above to conform with code formatting for the rest of the file.

michaelDCurran · 2017-01-17T00:13:31Z

nvdaHelper/vbufBackends/mshtml/mshtml.cpp

@@ -1130,6 +1143,16 @@ if(!(formatState&FORMATSTATE_INSERTED)&&nodeName.compare(L"INS")==0) {
 		||nodeName.compare(L"MATH")==0
 	) {
 		contentString=L" ";
+	} else if((nodeName.compare(L"A")==0)&&(attribsMap.find(L"HTMLAttrib::href")!=attribsMap.end())) {
+		renderChildren=true;


Again, I don't understand why renderChildren needs to be set to true.

michaelDCurran · 2017-01-17T00:18:56Z

source/virtualBuffers/__init__.py

@@ -366,7 +374,19 @@ def loadBuffer(self):

 	def _loadBuffer(self):
 		try:
-			self.VBufHandle=NVDAHelper.localLib.VBuf_createBuffer(self.rootNVDAObject.appModule.helperLocalBindingHandle,self.rootDocHandle,self.rootID,unicode(self.backendName))
+  			weblink=self.documentConstantIdentifier


Possibly move all this config fetching code into its own method which just returns the serialized labels string ready to pass to createBuffer.

michaelDCurran · 2017-01-17T00:20:59Z

source/virtualBuffers/__init__.py

+   		  	for k,v in config.iteritems():
+				labels+=k+":"+v+","
+
+			self.VBufHandle=NVDAHelper.localLib.VBuf_createBuffer(self.rootNVDAObject.appModule.helperLocalBindingHandle,self.rootDocHandle,self.rootID,unicode(self.backendName),unicode(labels))


As this is only supported for MSHTML so far, it might be best to add a class viarable on VirtualBuffer which can turn on and off support for labels. This would be set to True in mshtml's VirtualBuffer but False in the base VirtualBuffer, until all VirtualBuffers finally support labels. Otherwise you're reading in files and passing needless data when it willbe never used.

michaelDCurran · 2017-01-17T00:23:15Z

source/virtualBuffers/MSHTML.py

@@ -358,3 +370,4 @@ def shouldPassThrough(self, obj, reason=None):
 		except COMError:
 			pass
 		return super(MSHTML, self).shouldPassThrough(obj, reason)
+


Accidentally added blank line I think.

michaelDCurran · 2017-01-17T00:28:59Z

source/NVDAObjects/IAccessible/MSHTML.py

+		except Exception as e:
+   			pass
+
+	def getFilenameFromElementDomain(self):


Perhaps move this function into its own custom web labels module and then it can be used from the base VirtualBuffer as well... I think there is some code duplication.

michaelDCurran · 2017-01-17T00:38:40Z

source/virtualBuffers/MSHTML.py

+# 		elif (not nameAttribute):
+# 			customLabel=self.obj.rootNVDAObject.getCustomLabel(idAttribute)
+# 		if customLabel:
+# 			attrs["name"]=customLabel


This commented code should be removed.

jcsteh

@michaelDCurran is reviewing this instead.

… Explorer(for now)

michaelDCurran

Looks like you didn't add the customLabels.py file to the repository?

michaelDCurran · 2017-02-07T02:21:17Z

source/virtualBuffers/__init__.py

+				labels=self.fetchLabels()
+				self.VBufHandle=NVDAHelper.localLib.VBuf_createBuffer(self.rootNVDAObject.appModule.helperLocalBindingHandle,self.rootDocHandle,self.rootID,unicode(self.backendName),unicode(labels))
+			else:
+				self.VBufHandle=NVDAHelper.localLib.VBuf_createBuffer(self.rootNVDAObject.appModule.helperLocalBindingHandle,self.rootDocHandle,self.rootID,unicode(self.backendName))


If this does in deed work (not providing labels argument) it is probably hiding an error. Better to just have one call to createBuffer, but set labels to u"" if labels are disabled.

michaelDCurran · 2017-02-07T02:26:46Z

source/virtualBuffers/__init__.py

-			self.VBufHandle=NVDAHelper.localLib.VBuf_createBuffer(self.rootNVDAObject.appModule.helperLocalBindingHandle,self.rootDocHandle,self.rootID,unicode(self.backendName),unicode(labels))
+			if (self.labelSupportOn):
+				labels=self.fetchLabels()
+				self.VBufHandle=NVDAHelper.localLib.VBuf_createBuffer(self.rootNVDAObject.appModule.helperLocalBindingHandle,self.rootDocHandle,self.rootID,unicode(self.backendName),unicode(labels))


Rather than forcing labels to unicode here, it would be best that labels are unicode all of the way (I.e. they are unicode within the labels file itself if they are not already).

ManshulBelani · 2017-06-05T06:48:54Z

refer to pull request #7194

ManshulBelani added 11 commits August 22, 2016 19:43

clean build for assigning custom labels for links, graphics and form …

314af8b

…fields

custom label working solution for graphics and weblinks

09787dc

working solution for webLabels for links, graphics and form fields br…

582f0f2

…owse mode

assigning and reading custom labels for nodes in which name attribute…

667fa4e

… is not present in HTML

custom labels working for form fields, links and graphics while navig…

6a92d25

…ating in focus mode and browse mode.

clean code for adding web labels to HTML elements (links, graphics an…

b27cf4a

…d form fields)

solved problem of custom label being read twice in focus mode and bro…

95e3695

…wse mode

removing newlines

86f3dd4

code optimization

76eddca

removed extra comments

d58fde3

Merge branch 'master' into in_t5874_new

11ba862

feerrenrut requested a review from jcsteh December 30, 2016 04:43

michaelDCurran requested changes Jan 17, 2017

View reviewed changes

michaelDCurran changed the title ~~In t5874 new~~ Custom labels for MSHTML Jan 17, 2017

michaelDCurran reviewed Jan 17, 2017

View reviewed changes

added code review changes

de8d38e

jcsteh reviewed Jan 25, 2017

View reviewed changes

ManshulBelani added 2 commits January 30, 2017 15:51

moved custom labeling specific code to its own module

386098a

added code to turn on support for web labels only in case of Internet…

3d6ce16

… Explorer(for now)

michaelDCurran requested changes Feb 7, 2017

View reviewed changes

adding custom Label file to repo

c004675

ManshulBelani closed this Jun 5, 2017

LeonarddeR mentioned this pull request Jul 14, 2017

A feature to lable links and graphics where NVDA cannot. #3333

Closed

ruifontes mentioned this pull request Aug 18, 2017

Add number of the kinds of controls in logical order. #3988

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Custom labels for MSHTML #6619

Custom labels for MSHTML #6619

ManshulBelani commented Dec 6, 2016 •

edited by feerrenrut

feerrenrut commented Dec 30, 2016

michaelDCurran left a comment

michaelDCurran Jan 16, 2017

michaelDCurran Jan 17, 2017

michaelDCurran Jan 17, 2017

michaelDCurran Jan 17, 2017

michaelDCurran Jan 17, 2017

michaelDCurran Jan 17, 2017

michaelDCurran Jan 17, 2017

michaelDCurran Jan 17, 2017

michaelDCurran Jan 17, 2017

michaelDCurran Jan 17, 2017

jcsteh left a comment

michaelDCurran left a comment

michaelDCurran Feb 7, 2017

michaelDCurran Feb 7, 2017

ManshulBelani commented Jun 5, 2017

Custom labels for MSHTML #6619

Custom labels for MSHTML #6619

Conversation

ManshulBelani commented Dec 6, 2016 • edited by feerrenrut

feerrenrut commented Dec 30, 2016

michaelDCurran left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jcsteh left a comment

Choose a reason for hiding this comment

michaelDCurran left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ManshulBelani commented Jun 5, 2017

ManshulBelani commented Dec 6, 2016 •

edited by feerrenrut