BioGTK.Scripting Class Reference

Inheritance diagram for BioGTK.Scripting:

Classes
class	Script
class	State

Public Types
enum	Event { Down , Up , Move , None }
enum	ScriptType { tool , script , imagej }

Public Member Functions
void	InitItems ()
	It loads all the scripts in the Scripts and Tools folders into the TreeView.
void	RefreshItems ()
	It takes the list of scripts and puts them into a tree view.
void	RunScriptFile (string file)
void	Run ()
void	Stop ()

Static Public Member Functions
static Scripting	Create ()
static void	LogLine (string s)
static State	GetState ()
static bool	Exit (string name)
static void	UpdateState (State s)
static void	RunByName (string name)
static void	RunScript (string file)
static object	RunString (string st)

Static Public Attributes
static Window	window
static string	log
static string	output
static string	error
static string	ImageJPath = Fiji.ImageJPath
static Dictionary< string, Script >	scripts = new Dictionary<string,Script>()

Protected Member Functions
	Scripting (Builder builder, IntPtr handle)

Detailed Description

Definition at line 21 of file Scripting.cs.

Member Enumeration Documentation

Event

enum BioGTK.Scripting.Event

Definition at line 415 of file Scripting.cs.

        {
            Down,
            Up,
            Move,
            None
        }

ScriptType

enum BioGTK.Scripting.ScriptType

Definition at line 423 of file Scripting.cs.

        {
            tool,
            script,
            imagej
        }

Constructor & Destructor Documentation

Scripting()

BioGTK.Scripting.Scripting ( Builder builder, IntPtr handle )

protected

Definition at line 67 of file Scripting.cs.

                                                            : base(handle)
        {
            _builder = builder;
            builder.Autoconnect(this);
            scriptView.RowActivated += ScriptView_RowActivated;
            scriptView.ButtonPressEvent += ScriptView_ButtonPressEvent;
            this.KeyPressEvent += Scripting_KeyPressEvent;
            saveBut.ButtonPressEvent += SaveBut_ButtonPressEvent;
            runBut.ButtonPressEvent += runButton_Click;
            scriptLoadBut.ButtonPressEvent += scriptLoadBut_Click;
            outputBox.ButtonPressEvent += OutputBox_ButtonPressEvent;
            errorBox.ButtonPressEvent += OutputBox_ButtonPressEvent;
            logBox.ButtonPressEvent += OutputBox_ButtonPressEvent;
            stopBut.ButtonPressEvent += stopBut_Click;
            tabsView.SwitchPage += TabsView_SwitchPage;
            window = this;
            if (!Directory.Exists(System.IO.Path.GetDirectoryName(Environment.ProcessPath) + "//" + "Scripts"))
                Directory.CreateDirectory(System.IO.Path.GetDirectoryName(Environment.ProcessPath) + "//" + "Scripts");
            if (!Directory.Exists(System.IO.Path.GetDirectoryName(Environment.ProcessPath) + "//" + "Tools"))
                Directory.CreateDirectory(System.IO.Path.GetDirectoryName(Environment.ProcessPath) + "//" + "Tools");
            InitItems();
            scriptLabel.Text = "NewScript.cs";
            App.ApplyStyles(this);
        }

Member Function Documentation

Create()

static Scripting BioGTK.Scripting.Create ( )

static

It creates a new instance of the Scripting class, which is a class that inherits from the Gtk.Window class

Returns

A new instance of the Scripting class.

Definition at line 60 of file Scripting.cs.

        {
            Builder builder = new Builder(new FileStream(System.IO.Path.GetDirectoryName(Environment.ProcessPath) + "/" + "Glade/Scripting.glade", FileMode.Open));
            return new Scripting(builder, builder.GetObject("scripting").Handle);
        }

Exit()

static bool BioGTK.Scripting.Exit ( string name )

static

Definition at line 446 of file Scripting.cs.

        {
            if(scripts.ContainsKey(name))
            {
                return scripts[name].exit;
            }
            return false;
        }

GetState()

static State BioGTK.Scripting.GetState ( )

static

It returns the state of the game.

Returns

The state of the game.

Definition at line 441 of file Scripting.cs.

        {
            return state;
        }

InitItems()

void BioGTK.Scripting.InitItems

(

)

It loads all the scripts in the Scripts and Tools folders into the TreeView.

Definition at line 476 of file Scripting.cs.

        {
            Gtk.TreeViewColumn typeCol = new Gtk.TreeViewColumn();
            typeCol.Title = "Script";
            Gtk.CellRendererText typeCell = new Gtk.CellRendererText();
            typeCol.PackStart(typeCell, true);
            scriptView.AppendColumn(typeCol);
            typeCol.AddAttribute(typeCell, "text", 0);
 
            Gtk.TreeViewColumn statCol = new Gtk.TreeViewColumn();
            statCol.Title = "Status";
            Gtk.CellRendererText statCell = new Gtk.CellRendererText();
            statCol.PackStart(statCell, true);
            scriptView.AppendColumn(statCol);
            statCol.AddAttribute(statCell, "text", 1);
 
            Gtk.TreeStore store = new Gtk.TreeStore(typeof(string), typeof(string));
            scriptView.Model = store;
            scripts.Clear();
            string st = System.IO.Path.GetDirectoryName(Environment.ProcessPath);
            foreach (string file in Directory.GetFiles(st + "/Scripts"))
            {
                if (!scripts.ContainsKey(System.IO.Path.GetFileName(file)))
                {
                    Script sc = new Script(file, File.ReadAllText(file));
                    if(sc.thread == null)
                        store.AppendValues(sc.name, ThreadState.Unstarted.ToString());
                    else
                        store.AppendValues(sc.name, sc.thread.ThreadState.ToString());
                    scripts.Add(sc.name, sc);
                }
            }
            foreach (string file in Directory.GetFiles(st + "/Tools"))
            {
                if (file.EndsWith(".cs"))
                {
                    if (!scripts.ContainsKey(System.IO.Path.GetFileName(file)))
                    {
                        Script sc = new Script(file, File.ReadAllText(file));
                        if (sc.thread == null)
                            store.AppendValues(sc.name, ThreadState.Unstarted.ToString());
                        else
                            store.AppendValues(sc.name, sc.thread.ThreadState.ToString());
                        scripts.Add(sc.name, sc);
                    }
                }
            }
        }

LogLine()

static void BioGTK.Scripting.LogLine ( string s )

static

Definition at line 184 of file Scripting.cs.

        {
            log += s + Environment.NewLine;
        }

RefreshItems()

void BioGTK.Scripting.RefreshItems

(

)

It takes the list of scripts and puts them into a tree view.

Definition at line 526 of file Scripting.cs.

        {
            Gtk.TreeStore store = new Gtk.TreeStore(typeof(string), typeof(string));
            foreach (Script sc in scripts.Values)
            {
                if (sc.thread == null)
                    store.AppendValues(sc.name, ThreadState.Unstarted.ToString());
                else
                    store.AppendValues(sc.name, sc.thread.ThreadState.ToString());
            }
            scriptView.Model = store;
        }

Run()

void BioGTK.Scripting.Run

(

)

It runs the script that is currently selected in the list

Returns

The output of the script is being returned.

Definition at line 613 of file Scripting.cs.

        {
            log = "";
            outputBox.Buffer.Text = "";
            logBox.Buffer.Text = "";
            if (SelectedItem == null)
                return;
            //We run this script
            Script sc = SelectedItem;
            sc.scriptString = view.Buffer.Text;
            sc.output = "";
            sc.Run();
            outputBox.Buffer.Text = sc.output;
            logBox.Buffer.Text = log;
            RefreshItems();
        }

RunByName()

static void BioGTK.Scripting.RunByName ( string name )

static

Runs a script file by name

Parameters

file	The filename of the script you want to run.

Definition at line 580 of file Scripting.cs.

        {
            scripts[name].Run();
        }

RunScript()

static void BioGTK.Scripting.RunScript ( string file )

static

It creates a new script object, adds it to the dictionary, and then runs it

Parameters

file	The file path to the script.

Definition at line 597 of file Scripting.cs.

        {
            Script sc = new Script(file);
            scripts.Add(sc.name, sc);
            RunByName(sc.name);
        }

RunScriptFile()

void BioGTK.Scripting.RunScriptFile

(

string

file

)

It runs a script file

Parameters

file	The file path of the script you want to run.

Definition at line 587 of file Scripting.cs.

        {
            Script sc = new Script(file);
            scripts.Add(sc.name,sc);
            RefreshItems();
            RunByName(sc.name);
        }

RunString()

static object BioGTK.Scripting.RunString ( string st )

static

It runs a string as a Bio script

Parameters

st	The string to run.

Definition at line 606 of file Scripting.cs.

        {
            return Script.RunString(st);
        }

Stop()

void BioGTK.Scripting.Stop

(

)

We stop the script.

Returns

The SelectedItem is being returned.

Definition at line 632 of file Scripting.cs.

        {
            if (SelectedItem == null)
                return;
            //We stop this script
            SelectedItem.Stop();
            RefreshItems();
        }

UpdateState()

static void BioGTK.Scripting.UpdateState ( State s )

static

If the state is null, return. If the state is not null, set the state to the new state. If the state is not null and the new state is the same as the old state, set the processed flag to true

Parameters

State

The state of the game.

Returns

The state of the current object.

Definition at line 462 of file Scripting.cs.

        {
            if (s == null)
                return;
            if (state == null)
                state = s;
            if (s.p.X == state.p.X && s.p.Y == state.p.Y && s.type == state.type)
            {
                state.processed = true;
            }
            else
            state = s;
        }

Member Data Documentation

error

string BioGTK.Scripting.error

static

Definition at line 181 of file Scripting.cs.

ImageJPath

string BioGTK.Scripting.ImageJPath = Fiji.ImageJPath

static

Definition at line 182 of file Scripting.cs.

log

string BioGTK.Scripting.log

static

Definition at line 179 of file Scripting.cs.

output

string BioGTK.Scripting.output

static

Definition at line 180 of file Scripting.cs.

scripts

Dictionary<string,Script> BioGTK.Scripting.scripts = new Dictionary<string,Script>()

static

Definition at line 183 of file Scripting.cs.

window

Window BioGTK.Scripting.window

static

Definition at line 177 of file Scripting.cs.

---

The documentation for this class was generated from the following file:

• BioGTK/Source/Scripting.cs