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 = ImageJ.ImageJPath
static Dictionary< string, Script >	scripts = new Dictionary<string,Script>()

Protected Member Functions
	Scripting (Builder builder, IntPtr handle)

Member Enumeration Documentation

Event

enum BioGTK.Scripting.Event

Enumerator
Down
Up
Move
None

        {
            Down,
            Up,
            Move,
            None
        }

ScriptType

enum BioGTK.Scripting.ScriptType

Enumerator
tool
script
imagej

        {
            tool,
            script,
            imagej
        }

Constructor & Destructor Documentation

Scripting()

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

inlineprotected

                                                            : 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 ( )

inlinestatic

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.

        {
            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 )

inlinestatic

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

GetState()

static State BioGTK.Scripting.GetState ( )

inlinestatic

It returns the state of the game.

Returns

The state of the game.

        {
            return state;
        }

InitItems()

void BioGTK.Scripting.InitItems ( )

inline

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

        {
            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 )

inlinestatic

        {
            log += s + Environment.NewLine;
        }

RefreshItems()

void BioGTK.Scripting.RefreshItems ( )

inline

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

        {
            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 ( )

inline

It runs the script that is currently selected in the list

Returns

The output of the script is being returned.

        {
            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 )

inlinestatic

Runs a script file by name

Parameters

file	The filename of the script you want to run.

        {
            scripts[name].Run();
        }

RunScript()

static void BioGTK.Scripting.RunScript ( string  file )

inlinestatic

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

Parameters

file	The file path to the script.

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

RunScriptFile()

void BioGTK.Scripting.RunScriptFile ( string  file )

inline

It runs a script file

Parameters

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

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

RunString()

static object BioGTK.Scripting.RunString ( string  st )

inlinestatic

It runs a string as a Bio script

Parameters

st	The string to run.

        {
            return Script.RunString(st);
        }

Stop()

void BioGTK.Scripting.Stop ( )

inline

We stop the script.

Returns

The SelectedItem is being returned.

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

UpdateState()

static void BioGTK.Scripting.UpdateState ( State  s )

inlinestatic

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.

        {
            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

ImageJPath

string BioGTK.Scripting.ImageJPath = ImageJ.ImageJPath

static

log

string BioGTK.Scripting.log

static

output

string BioGTK.Scripting.output

static

scripts

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

static

window

Window BioGTK.Scripting.window

static

---

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

• D:/Kari/repos/BioGTK/Source/Scripting.cs