Tuesday, 23 July 2013

Weeks 4 and 5

Hey, as mentioned in my previous posts, I'm working on revamping Amarok's Scripting Interface as part of this year's Google Summer of Code. For those of you who've been living under a rock, Amarok is the best thing in music players since the phonograph.

So here's what I've been upto:

  • Scripting documentation
One of the biggest gripes about Amarok's scripting API has been the lack of documentation. There's mostly just a manually created [read error-prone] list of exposed interfaces on the wiki.

Auto-magic documentation of the scripting API posed a different challenge, as the scripting API does not resemble the standard Amarok C++ code.
After procrastinating it for a good three weeks ( how many of us follow their proposals, anyway? ), I settled on this python script to generate a pseudo-header, and also an auto-completion list, but more on that later.

Here's the resulting doxygen output.

It's not perfect yet, but the results look pretty decent. Please do comment though if you know of a better way of going about this!


  • Autocomplete
The script console's auto-complete is working now. Because nobody likes looking up the documentation too often ( or retrying, or introspecting, or whatever ),  just to get the syntax of an arbitrarily named interface right.



Sadly, no contextual information, but anything more would probably require me to move to kdevplatform. Any katepart/ ktexteditor guys willing to correct me?






  • Deprecation Notification


This might be one of the more controversial additions, but hey, it's all for the greater good.

Users running scripts accessing deprecated API calls see a popup of the sort on the left, so they can bug script writers into updating their scripts.





What are your views on this, Amarok Script Writers?


  • No restarts
That's right, you no longer have to restart on installing a new script in Amarok, so you can right down to listening to your Google Music content after installing the script ( well, as soon as streamitem's fixed in my branch actually ).

There's more changes under the hood, and still lots more to cleanup and document, but I have new leads - Markey just pointed me Richard Dale's SMOKE, which might hopefully help get things done better.

3 comments:

  1. Here you have showed the work activities which you did in 4 to 5 weeks. I think this post is actually a complete tutorial and we can follow it to have solution of this problem. However, I need Essay Mama and at the same time this will be good for me.

    ReplyDelete
  2. Good Post.When you order essay in online writing service, it has many advantages. You will get your ordered essay as soon as possible, even you have just few days to submit your essay or closed to deadline. Your essay paper best essay writing service will be well structured and well written according to all norms. Here the best essay writing service writers will ensure you about the style of your essay. This online essay writing service is very useful when you don’t have time to write your essay. You can take help from them. They will give best essay paper within the time. It is also very useful when you need someone to proof read your essay and edit your essay as well. And if you are not fluent in English and you are not sure about your quality of essay and need some ones help to check your essay. If you are ordering from best essay service online, then you no need to bother about all these issues. If you want to order your essay task with the essay writing service, it doesn’t mean that you are lazy or incapable of writing good essay. When someone is in very difficult situation to write their own essay such as; lack of time or possibility to write essay yourself, then you can go for essay writing service. What you have to do is while ordering your essay; place your order with the n best essay writing service. And give all your requirements for your essay. Tell them what type of essay you need and when you need your complete essay. The writer of best essay writing service will give their 100% effort to meet your all requirements of essay and they will give you the best essay within the time period. So just go and order essay as soon as possible.


    ReplyDelete
  3. Amazing skill you have to keep readers bound....Thanks for sharing the post.. Tik Tok

    ReplyDelete