adBlocks Console Module

[jgarfield]

I've had a few requests for an updated version of our console module. I'll be posting this updated version to our consulting page but thought it might be found by more people here.

We've tried to make it as extensible as possible so that you can add your own functionality to it as needed. If you have any questions about the console, how to use it, extend it, etc, please feel free to let me know.

Also, if you make any modifications, I would love to hear about them, and I'm sure the rest of the community would as well. So drop a post here and let us know what you've done!

Once you've imported the module into Servoy (it works in 3.5 and 4 as far as I know) just run the method 'showCosole' to bring it up. At adBlocks we bind that to a method that runs when we press ctrl+1, but there are plenty of other ways to use it (I believe Troy has the most interesting one I've seen).

Once at the console prompt, just type "help" and you should be well on your way.

Enjoy!

[Karel Broer]

Thanks for sharing this excellent tool guys! I use the console for many years now and it's become a standard tool in the STB framework.
Loved the tips and tricks session at SW and looking forward to see you next year at SW'09!

[BenBaby]

Thank you so much James - you guys rock!

Sincerely,

Ben

[Karel Broer]

I made a small method that shows you what plugins are installed (and some have version info with them too ):

Code: Select all

/********************************************************************************
   @method: view_plugins()

   @return:

   @description: show list of current plugins with (optional) version info

   @note:

   @history:   14/09/2008   Created by Karel Broer
********************************************************************************/

var vPlugins = plugins.allnames
vPlugins.sort();
var vText = ''
var vName
for(var i in vPlugins){
   vName = vPlugins[i]
   if(plugins[vName] && plugins[vName].getVersion){
      vText += vName + '&nbsp&nbsp<b>' + plugins[vName].getVersion() + '</b><br>'
   }
   else {
      vText += vName + '<br>'
   }
}

return vText

If you add this method on the _console form and type 'run view_plugins()' you'll see a nice list of plugs.
Have fun with it!

[david]

One of our favorite tools. Thanks guys!

[jgarfield]

I made a small method that shows you what plugins are installed (and some have version info with them too ):

If you'd like I've added modifications to the code to make this a command you can run directly from the console just by typing "plugins", instead of "run view_plugins()".

The trick mainly lies in naming the method in the form of console_commandNameHere

After that you just have to add in the logic for dealing with the syntax argument, and change the return text to be in oArg.result , and then return either true or false to indicate success or failure.

console_query is a good example of how to do some simple parsing for arguments, and how different returns work if you are interested.

Code: Select all

/********************************************************************************
   @method: console_plugins()

   @arg oArg
   @opt oArg.syntax

   @return:

   @description: show list of current plugins with (optional) version info

   @note:

   @history:   14/09/2008   Created by Karel Broer
   @history:   15/09/2008   Modified by James Garfield
********************************************************************************/

var oArg = arguments[0];

if (oArg.syntax)
{
   var oSyntax = new Object();
   oSyntax.description = "Display information about installed plugins"
   oSyntax.syntax = new Array();
   oSyntax.syntax.push('license');
   return oSyntax;
}

var vPlugins = plugins.allnames
vPlugins.sort();
var vText = ''
var vName
for(var i in vPlugins){
   vName = vPlugins[i]
   if(plugins[vName] && plugins[vName].getVersion){
      vText += vName + '&nbsp&nbsp<b>' + plugins[vName].getVersion() + '</b><br>'
   }
   else {
      vText += vName + '<br>'
   }
}

oArg.result = vText;

return true;


[Karel Broer]

If you'd like I've added modifications to the code to make this a command you can run directly from the console just by typing "plugins", instead of "run view_plugins()".

Excellent modification James! Thanks a bunch!