BrawlLib.SSBB.ResourceNodes.GCTNode Class Reference

Inheritance diagram for BrawlLib.SSBB.ResourceNodes.GCTNode:

Public Member Functions
override bool	OnInitialize ()
override void	OnPopulate ()
override int	OnCalculateSize (bool force)
override void	OnRebuild (VoidPtr address, int length, bool force)
void	ToTXT ()
void	ToTXT (string path)
Public Member Functions inherited from BrawlLib.SSBB.ResourceNodes.ResourceNode
void	OnRenamed ()
List< ResourceNode >	GetChildrenRecursive ()
	Used primarily to get bone lists. Kept for all resource nodes for utility. More...
virtual void	SignalPropertyChange ()
virtual void	Dispose ()
void	SelectChildAtIndex (int index)
void	UpdateProperties ()
void	UpdateCurrentControl ()
virtual bool	MoveUp ()
virtual bool	MoveDown ()
virtual void	OnMoved ()
virtual void	DoMoveDown ()
virtual void	DoMoveDown (bool select)
virtual void	DoMoveUp ()
virtual void	DoMoveUp (bool select)
virtual bool	AddUp ()
virtual bool	AddDown ()
virtual bool	ToParent ()
void	Populate (int levels=-1)
virtual void	OnPopulate ()
void	Initialize (ResourceNode parent, FileMap source)
void	Initialize (ResourceNode parent, VoidPtr address, int length)
void	Initialize (ResourceNode parent, DataSource origSource)
virtual void	Initialize (ResourceNode parent, DataSource origSource, DataSource uncompSource)
virtual bool	OnInitialize ()
virtual void	Restore ()
virtual void	Remove ()
virtual void	RemoveChild (ResourceNode child)
virtual void	AddChild (ResourceNode child)
virtual void	AddChild (ResourceNode child, bool change)
virtual void	InsertChild (ResourceNode child, int index)
virtual void	InsertChild (ResourceNode child, bool change, int index)
void	SetSizeInternal (int size)
virtual void	Replace (string fileName)
virtual void	Replace (ResourceNode node)
virtual void	Replace (string fileName, FileMapProtect prot, FileOptions options)
virtual void	ReplaceRaw (VoidPtr address, int length)
virtual void	ReplaceRaw (FileMap map)
virtual void	Export (string outPath)
void	Export (FileStream outStream)
virtual void	ExportUncompressed (string outPath)
void	ExportUncompressed (FileStream outStream)
virtual void	Rebuild ()
virtual void	Rebuild (bool force)
virtual void	Rebuild (VoidPtr address, int length, bool force)
virtual void	OnRebuild (VoidPtr address, int length, bool force)
virtual int	CalculateSize (bool force)
virtual int	OnCalculateSize (bool force)
void	Merge ()
void	Merge (bool forceBuild)
ResourceNode	FindChildByType (string path, bool searchChildren, params ResourceType[] types)
ResourceNode	FindChildByType (string path, bool searchChildren, StringComparison compare, params ResourceType[] types)
ResourceNode	FindChild (string path)
ResourceNode	FindChild (string path, bool searchChildren)
ResourceNode	FindChild (string path, StringComparison compare)
ResourceNode	FindChild (string path, bool searchChildren, StringComparison compare)
ResourceNode[]	FindChildrenByClassType (string path, Type type)
ResourceNode[]	FindChildrenByType (string path, ResourceType type)
ResourceNode[]	FindChildrenByTypeInGroup (string path, ResourceType type, byte group)
ResourceNode[]	FindChildrenByName (string name)
unsafe string	FindName (string name)
ResourceNode	FindEmbeddedIndex (int index)
virtual unsafe byte[]	MD5 ()
	Find the MD5 checksum of this node's data. If this node doesn't have any data (BRESGroupNode, for example), this method will return null. More...
string	MD5Str ()
	Get the result of the MD5() function as a string of hexadecimal digits. If MD5() returns null, this method will return an empty string. More...
ResourceNode	PrevSibling ()
ResourceNode	NextSibling ()
override string	ToString ()
virtual void	SortChildren ()

Static Public Member Functions
static GCTNode	FromTXT (string path)
static GCTNode	IsParsable (string path)
Static Public Member Functions inherited from BrawlLib.SSBB.ResourceNodes.ResourceNode
static ResourceNode[]	FindAllSubNodes (ResourceNode root)
static ResourceNode	FindNode (ResourceNode root, string path, bool searchChildren, StringComparison compare)

Public Attributes
string	_gameName
bool	_writeInfo = true
Public Attributes inherited from BrawlLib.SSBB.ResourceNodes.ResourceNode
Form	_mainForm
string	_name
string	_origPath
ResourceNode	_parent
List< ResourceNode >	_children = new List<ResourceNode>()
int	_calcSize
EventHandler	UpdateControl
MoveEventHandler	MovedDown
ResourceEventHandler	Renamed
ResourceEventHandler	PropertyChanged
ResourceEventHandler	Replaced
ResourceEventHandler	Restored
ResourceChildEventHandler	ChildRemoved
bool	_isPopulating
bool	_replaced

Properties
override ResourceType	ResourceFileType [get]
override bool	AllowNullNames [get]
override bool	AllowDuplicateNames [get]
string	GameName [get, set]
Properties inherited from BrawlLib.SSBB.ResourceNodes.ResourceNode
string	FilePath [get]
string	FileName [get]
string	DirectoryName [get]
ResourceNode	RootNode [get]
DataSource	OriginalSource [get]
DataSource	UncompressedSource [get]
DataSource	WorkingSource [get]
DataSource	WorkingUncompressed [get]
virtual bool	HasChildren [get]
virtual ResourceType	ResourceFileType [get]
string	NodeType [get]
virtual string	TreePathAbsolute [get]
virtual string	TreePath [get]
virtual int	Level [get]
virtual int	MaxNameLength [get]
virtual bool	AllowDuplicateNames [get]
virtual bool	AllowNullNames [get]
virtual string	Name [get, set]
ResourceNode	Parent [get, set]
List< ResourceNode >	Children [get]
int	Index [get]
int	HexIndex [get]
bool	IsCompressed [get]
bool	HasChanged [get, set]
bool	IsBranch [get]
bool	HasMerged [get]
virtual bool	AllowSaving [get, set]
virtual bool	IsDirty [get, set]
virtual uint	UncompressedSize [get]
virtual Type[]	AllowedChildTypes [get]
virtual string	Compression [get, set]
virtual bool	RetainChildrenOnReplace [get]
virtual bool	supportsCompression [get]
static MD5CryptoServiceProvider	MD5Provider [get]

Additional Inherited Members
Protected Member Functions inherited from BrawlLib.SSBB.ResourceNodes.ResourceNode
void	ForceReplacedEvent ()
virtual void	MergeInternal ()
Events inherited from BrawlLib.SSBB.ResourceNodes.ResourceNode
SelectEventHandler	SelectChild
EventHandler	UpdateProps
MoveEventHandler	MovedUp
ResourceEventHandler	Disposing
ResourceChildEventHandler	ChildAdded
ResourceChildInsertEventHandler	ChildInserted

Member Function Documentation

FromTXT()

static GCTNode BrawlLib.SSBB.ResourceNodes.GCTNode.FromTXT ( string  path )

inlinestatic

        {
            GCTNode node = new GCTNode();
 
            if (File.Exists(path))
            {
                bool anyEnabled = false;
 
                using (StreamReader sr = new StreamReader(path))
                {
                    for (int i = 0; !sr.EndOfStream; i++)
                    {
                        string lastLine;
                        while (string.IsNullOrEmpty(lastLine = sr.ReadLine()))
                        {
                            ;
                        }
 
                        if (!string.IsNullOrEmpty(lastLine))
                        {
                            node._name = lastLine;
                        }
 
                        while (!sr.EndOfStream)
                        {
                            while (string.IsNullOrEmpty(lastLine = sr.ReadLine()))
                            {
                                ;
                            }
 
                            GCTCodeEntryNode e = new GCTCodeEntryNode();
                            List<GCTCodeLine> g = new List<GCTCodeLine>();
 
                            if (!string.IsNullOrEmpty(lastLine))
                            {
                                e._name = lastLine;
                            }
                            else
                            {
                                break;
                            }
 
                            bool? codeEnabled = null;
                            while (true)
                            {
                                lastLine = sr.ReadLine();
                                if (string.IsNullOrEmpty(lastLine))
                                {
                                    break;
                                }
 
                                bool lineEnabled = lastLine.StartsWith("* ");
                                if (lineEnabled)
                                {
                                    anyEnabled = true;
                                    lastLine = lastLine.Substring(2);
                                }
 
                                if (codeEnabled == null)
                                {
                                    codeEnabled = lineEnabled;
                                }
                                else if (codeEnabled != lineEnabled)
                                {
                                    break;
                                }
 
                                string[] lines = lastLine.Split(' ');
                                if (lines.Length < 2)
                                {
                                    break;
                                }
 
                                if (uint.TryParse(lines[0], NumberStyles.HexNumber, CultureInfo.InvariantCulture,
                                    out uint val1))
                                {
                                    if (uint.TryParse(lines[1], NumberStyles.HexNumber, CultureInfo.InvariantCulture,
                                        out uint val2))
                                    {
                                        GCTCodeLine l = new GCTCodeLine(val1, val2);
                                        g.Add(l);
                                    }
                                    else
                                    {
                                        break;
                                    }
                                }
                                else
                                {
                                    break;
                                }
                            }
 
                            List<string> description = new List<string>();
                            while (!string.IsNullOrEmpty(lastLine))
                            {
                                description.Add(lastLine);
                                lastLine = sr.ReadLine();
                            }
 
                            e._enabled = codeEnabled ?? false;
                            e._lines = g.ToArray();
                            e._description = string.Join(Environment.NewLine, description);
                            if (e._lines.Length > 0)
                            {
                                node.AddChild(e, false);
                            }
                        }
                    }
                }
 
                if (anyEnabled == false)
                {
                    // No codes enabled in file - enable all codes
                    foreach (GCTCodeEntryNode e in node.Children)
                    {
                        e._enabled = true;
                    }
                }
            }
 
            node._origPath = path;
            return node;
        }

IsParsable()

static GCTNode BrawlLib.SSBB.ResourceNodes.GCTNode.IsParsable ( string  path )

inlinestatic

        {
            FileMap map = FileMap.FromFile(path, FileMapProtect.ReadWrite);
 
            GCTCodeLine* data = (GCTCodeLine*) map.Address;
            if (GCTCodeLine.Tag._1 != data->_1 || GCTCodeLine.Tag._2 != data->_2)
            {
                map.Dispose();
                return null;
            }
 
            data = (GCTCodeLine*) (map.Address + (uint) Helpers.RoundDown((uint) map.Length, 8) - GCTCodeLine.Size);
            bool endFound = false;
            int i = 0;
            while (!endFound)
            {
                GCTCodeLine line = *data--;
                if (line._1 == GCTCodeLine.End._1 && line._2 == GCTCodeLine.End._2)
                {
                    endFound = true;
                    break;
                }
 
                i++;
            }
 
            if (endFound && i <= 0)
            {
                data = (GCTCodeLine*) map.Address + 1;
 
                string s = "";
                while (true)
                {
                    GCTCodeLine line = *data++;
                    if (line._1 == GCTCodeLine.End._1 && line._2 == GCTCodeLine.End._2)
                    {
                        break;
                    }
 
                    s += line.ToStringNoSpace();
                }
 
                GCTNode g = new GCTNode {_origPath = path};
 
                List<string> _unrecognized = new List<string>();
 
                if (Properties.Settings.Default.Codes != null)
                {
                    foreach (CodeStorage c in Properties.Settings.Default.Codes)
                    {
                        int index = -1;
                        if ((index = s.IndexOf(c._code)) >= 0)
                        {
                            g.AddChild(new GCTCodeEntryNode
                            {
                                _name = c._name,
                                _description = c._description,
                                LinesNoSpaces = s.Substring(index, c._code.Length),
                                _enabled = true
                            }, false);
                            s = s.Remove(index, c._code.Length);
                        }
                    }
                }
 
                if (s.Length > 0)
                {
                    g.AddChild(
                        new GCTCodeEntryNode {_name = "Unrecognized Code(s)", LinesNoSpaces = s, _enabled = true},
                        false);
                }
 
                if (g._name == null)
                {
                    g._name = Path.GetFileNameWithoutExtension(path);
                }
 
                return g;
            }
 
            if (endFound && i > 0)
            {
                GCTNode g = new GCTNode();
                g.Initialize(null, new DataSource(map));
                return g;
            }
 
            map.Dispose();
            return null;
        }

OnCalculateSize()

override int BrawlLib.SSBB.ResourceNodes.GCTNode.OnCalculateSize ( bool  force )

inlinevirtual

Reimplemented from BrawlLib.SSBB.ResourceNodes.ResourceNode.

        {
            int size = 16;
            foreach (GCTCodeEntryNode n in Children)
            {
                size += n._lines.Length * 8;
            }
 
            if (_writeInfo)
            {
                _stringTable = new CompactStringTable();
                _stringTable.Add(_name);
                if (!string.IsNullOrEmpty(_gameName))
                {
                    _stringTable.Add(_gameName);
                }
 
                size += 12;
                foreach (GCTCodeEntryNode n in Children)
                {
                    size += 16;
                    _stringTable.Add(n._name);
                    if (!string.IsNullOrEmpty(n._description))
                    {
                        _stringTable.Add(n._description);
                    }
                }
 
                size += _stringTable.TotalSize;
            }
 
            return size;
        }

OnInitialize()

override bool BrawlLib.SSBB.ResourceNodes.GCTNode.OnInitialize ( )

inlinevirtual

Reimplemented from BrawlLib.SSBB.ResourceNodes.ResourceNode.

        {
            base.OnInitialize();
 
            GCTCodeLine* lines = (GCTCodeLine*) Data + 1;
            while (true)
            {
                GCTCodeLine line = *lines++;
                if (line._1 == GCTCodeLine.End._1 && line._2 == GCTCodeLine.End._2)
                {
                    break;
                }
            }
 
            _header = (GCTHeader*) lines;
            if ((uint) _header - (uint) Data < WorkingUncompressed.Length)
            {
                if (_header->_nameOffset > 0)
                {
                    _gameName = _header->GameName;
                }
 
                _name = _header->GameID;
            }
 
            if (_name == null)
            {
                _name = Path.GetFileNameWithoutExtension(_origPath);
            }
 
            return WorkingUncompressed.Length > 16 && _header->_count > 0;
        }

OnPopulate()

override void BrawlLib.SSBB.ResourceNodes.GCTNode.OnPopulate ( )

inlinevirtual

Reimplemented from BrawlLib.SSBB.ResourceNodes.ResourceNode.

        {
            GCTCodeEntry* entry = (GCTCodeEntry*) (_header + 1);
            for (int i = 0; i < _header->_count; i++)
            {
                new GCTCodeEntryNode(&entry[i]).Initialize(this, Data + entry[i]._codeOffset,
                    (int) entry[i]._lineCount * GCTCodeLine.Size);
            }
        }

OnRebuild()

override void BrawlLib.SSBB.ResourceNodes.GCTNode.OnRebuild ( VoidPtr  address, int  length, bool  force  )

inlinevirtual

Reimplemented from BrawlLib.SSBB.ResourceNodes.ResourceNode.

        {
            List<GCTCodeEntryNode> enabledChildren =
                Children.Select(e => (GCTCodeEntryNode) e).Where(e => e._enabled).ToList();
 
            GCTCodeLine* line = (GCTCodeLine*) address;
            *line++ = GCTCodeLine.Tag;
            foreach (GCTCodeEntryNode n in enabledChildren)
            {
                foreach (GCTCodeLine l in n._lines)
                {
                    *line++ = l;
                }
            }
 
            *line++ = GCTCodeLine.End;
            if (_writeInfo)
            {
                GCTHeader* hdr = (GCTHeader*) line;
                hdr->_count = (uint) enabledChildren.Count;
 
                int offset = 12 + enabledChildren.Count * 16;
                _stringTable.WriteTable((VoidPtr) hdr + offset);
 
                hdr->_idOffset = (uint) _stringTable[_name] - (uint) hdr;
                if (!string.IsNullOrEmpty(_gameName))
                {
                    hdr->_nameOffset = (uint) _stringTable[_gameName] - (uint) hdr;
                }
                else
                {
                    hdr->_nameOffset = 0;
                }
 
                GCTCodeEntry* entry = (GCTCodeEntry*) (hdr + 1);
                uint codeOffset = 8;
                foreach (GCTCodeEntryNode n in enabledChildren)
                {
                    entry->_codeOffset = codeOffset;
                    codeOffset += (uint) n._lines.Length * 8;
 
                    entry->_lineCount = (uint) n._lines.Length;
                    entry->_nameOffset = (uint) _stringTable[n._name] - (uint) entry;
                    if (!string.IsNullOrEmpty(n._description))
                    {
                        entry->_descOffset = (uint) _stringTable[n._description] - (uint) entry;
                    }
                    else
                    {
                        entry->_descOffset = 0;
                    }
 
                    entry++;
                }
            }
        }

ToTXT() [1/2]

void BrawlLib.SSBB.ResourceNodes.GCTNode.ToTXT ( )

inline

        {
            SaveFileDialog d = new SaveFileDialog
            {
                Filter = "Text File|*.txt"
            };
            if (d.ShowDialog() == DialogResult.OK)
            {
                ToTXT(d.FileName);
            }
        }

ToTXT() [2/2]

void BrawlLib.SSBB.ResourceNodes.GCTNode.ToTXT ( string  path )

inline

        {
            using (StreamWriter file = new StreamWriter(path))
            {
                file.WriteLine(_name);
                file.WriteLine(_gameName);
                foreach (GCTCodeEntryNode n in Children)
                {
                    file.WriteLine();
                    file.WriteLine(n._name);
                    file.Write(n.DisplayLines);
                    if (!string.IsNullOrWhiteSpace(n._description))
                    {
                        file.WriteLine(n._description);
                    }
                }
            }
        }

Member Data Documentation

_gameName

string BrawlLib.SSBB.ResourceNodes.GCTNode._gameName

_writeInfo

bool BrawlLib.SSBB.ResourceNodes.GCTNode._writeInfo = true

Property Documentation

AllowDuplicateNames

override bool BrawlLib.SSBB.ResourceNodes.GCTNode.AllowDuplicateNames

get

AllowNullNames

override bool BrawlLib.SSBB.ResourceNodes.GCTNode.AllowNullNames

get

GameName

string BrawlLib.SSBB.ResourceNodes.GCTNode.GameName

getset

        {
            get => _gameName;
            set
            {
                _gameName = value;
                SignalPropertyChange();
            }
        }

ResourceFileType

override ResourceType BrawlLib.SSBB.ResourceNodes.GCTNode.ResourceFileType

get

---

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

• BrawlLib/SSBB/ResourceNodes/GCTNode.cs