GNOME.org
 

Re: [orca-list] Programers guide for Orca development

My goodness!  Thanks, José for posting this.  It admirably underscores the desperate need for a concise, 
complete and well-written developer's guide for Orca.  Perhaps it is my own ignorance of matters programming 
but, I imagine only the very most persistent and dedicated people with a great deal of disposable time are 
likely to contribute anything substantial to Orca development.  This is quite disheartening.  I am going to 
look into Doxygen and see about learning how to run Orca's source code trough it in order to extrapolate the 
comments from it.  I will then post the results of my efforts to the list for someone else more versed in 
these sorts of things to hopefully pick up the ball and run with it.  I will not propose a timetable for this 
as I am sadly not one of those people with lots of disposable time and I shall have to learn a few things 
along the way.  However, I feel that SOMEONE has to step up and do something about this or community 
development of enhancements to Orca beyond small modifications or the odd script or two will never go from 
wish to reality. I think of products like Window Eyes with tens if not hundreds of plugins written by its 
user community and that's not even an open source project.  I can only imagine the amazing things that can be 
done on something like Orca given the availability of proper developer docs. 

Alex M



-----Original Message-----
From: José Vilmar Estácio de Souza [mailto:vilmar informal com br] 
Sent: Monday, December 29, 2014 5:52 AM
To: Krishnakant Mane; luciano de souza; Alex Midence
Cc: orca-list
Subject: Re: [orca-list] Programers guide for Orca development

A small piece from a debug file:

KEYBOARDEVENT: type=0
                 id=65364
                 hw_code=116
                 modifiers=16400
                 event_string=(Down)
                 keyval_name=(Down)
                 is_text=True
                 timestamp=101591371
                 time=1419852915.746248
                 keyType=navigation
                 shouldEcho=False


In this case, a key was pressed, the down key.



----------> QUEUEING OBJECT:TEXT-CARET-MOVED

An event called OBJECT:TEXT-CARET-MOVED was post in orca's queue to be processed.



vvvvv PROCESS OBJECT EVENT object:text-caret-moved vvvvv
OBJECT EVENT: object:text-caret-moved detail=(4,0,0)
     app.name='gedit' name='None' role='text' state='editable enabled 
focusable focused multi line sensitive showing visible' relations=''
Script for event: gedit (module=orca.scripts.apps.gedit.script)
TOTAL PROCESSING TIME: 0.0039
^^^^^ PROCESS OBJECT EVENT object:text-caret-moved ^^^^^

The event was processed.

In the gedit scripts there is a function called onCaretMoved, 
responsable to process this event.
     def onCaretMoved(self, event):
         """Callback for object:text-caret-moved accessibility events."""


On 12/29/2014 09:26 AM, Krishnakant Mane wrote:

Thans for the suggestion about debug.
Even I will try it tonight.
happy hacking.
Krishnakant.

On 12/29/2014 04:41 PM, José Vilmar Estácio de Souza wrote:

Hi.
Some small tips:
1. try to work with orca from git, not downloaded from a tar package.

In general new implementations are applied in the master version of 
orca.

2. Take a look in a debug file produced by orca. All events captured 
and processed by orca are present in this debug file. To generate a 
debug file run the following command:
orca --replace --debug-file=orca.debug
The command above run orca in debug mode and write all information to 
the orca.debug file.
Make a small operation like move the cursor in gedit program and 
restart orca.
Now examine the content of orca.debug.





On 12/29/2014 08:36 AM, luciano de souza wrote:

It's perfectly understandable. The quantity of effort to provide a
complete manual is meaningful.

We need to work with the way we have. And this way is the source code.

I have downloaded the source code and I start to navigate in the code.
My first idea was to take a look in the scripts made for specific
applications.

I have chosen the plugin of Pidgin. I observed all plugins have a
standard "script.py" file. I decided to start from here.

I observed that it's common a class named "Script". Probabily, it's
the class responsible to get the events and fire custom actions
answering from events or key bindings.

I observed also the module pyatspi. Searching in the Google, I
understood this module is the Gnome infrastructure of accessibility.
Yes, I need to study it.

My conclusion is: it's really possible to follow the code and learn by
means of it. Lots of comments are provided.

But, the problem is: how to run the first "hello world" Orca script? I
found strange classes like "SpeechGenerator". I don't know what is a
SpeeachGenerator, but it seems that each application has one of it.

Yes, we don't have a manual, but, there are at least a example codes
or at least an instruction from where a beginer can start his or her
study of code?

I am really interested in helping. Is difficult without a
documentation? Certainly. But the worst is not understand by where to
start. Without any additional word, the dificulty will never be
converted into easiness.

2014-12-29 2:14 GMT-02:00, Alex Midence <alex midence gmail com>:

No such animal. People have asked for it, no one has put one 
together, so
everybody has to start reading the actual code. Good luck!

Sent from my iPhone


On Dec 28, 2014, at 8:28 PM, luciano de souza <luchyanus gmail com>
wrote:

Hello all,

I have been studying Python. As I had already programed in Pascal and
Lua, it has been a very pleasant and quick task.

The final target is to learn about Orca development, creating
something useful for the comunity.

I know the way is very long. I can imagine the quantity of experience
required to develop something for Orca is very big.

But I need to start from anywhere. Even though, my knowledge in 
Python
is still limited, I would like to read the Orca programer's guide. 
The
task is very complex, but perhaps there is some parts of the code is
not so complex.

I don't know. Exactly now, I am even not sure if I will able to 
follow
this target until the success. I simply don't know the size of the
challenge.

I believe that reading the documentation I will feel better what's 
the
distance wich separates me to the Orca development.

Said it, I ask: where can I find materials for beginers in Orca
development?

Regards,


-- 
Luciano de Souza
_______________________________________________
orca-list mailing list
orca-list gnome org
https://mail.gnome.org/mailman/listinfo/orca-list
Visit http://live.gnome.org/Orca for more information on Orca.
The manual is at
http://library.gnome.org/users/gnome-access-guide/nightly/ats-2.html
The FAQ is at http://live.gnome.org/Orca/FrequentlyAskedQuestions
Log bugs and feature requests at http://bugzilla.gnome.org
Find out how to help at http://live.gnome.org/Orca/HowCanIHelp








-- 
[]s  José Vilmar Estácio de Souza
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]