'OHRRPGCE - RELOAD related functions
'(C) Copyright 1997-2020 James Paige, Ralph Versteegen, and the OHRRPGCE Developers
'Dual licensed under the GNU GPL v2+ and MIT Licenses. Read LICENSE.txt for terms and disclaimer of liability.

#ifndef RELOAD_BI
#define RELOAD_BI

#include "config.bi"
#include "util.bi"
#include "lumpfile.bi"

'if you find yourself debugging heap issues, define this. If the crashes go away, then I (Mike Caron)
'somehow fscked up the private heap implementation. Or, someone else touched something without
'understanding how it works...

'#define RELOAD_NOPRIVATEHEAP

#ifdef MINIMAL_OS
#define RELOAD_NOPRIVATEHEAP
#endif

#if defined(__FB_WIN32__) and not defined(RELOAD_NOPRIVATEHEAP)
#if defined(RELOADINTERNAL) or __FB_DEBUG__
        type HANDLE as any ptr
#endif
#endif

Namespace Reload

ENUM NodeInTypes
	rliNull = 0
	rliByte = 1
	rliShort = 2
	rliInt = 3
	rliLong = 4
	rliFloat = 5
	rliString = 6
END ENUM

ENUM NodeTypes
	rltNull
	rltInt
	rltFloat
	rltString        'Allocated string or blob of data, modifiable
	rltInternString  'Pointer to an interned (read-only) string
END ENUM

ENUM LoadOptions
	optNone = 0
	optNoDelay = 1        'Load whole file into memory immediately
	optIgnoreMissing = 2  'Don't print an error if the file is missing
END ENUM

TYPE DocPtr as Doc ptr
TYPE NodePtr as Node ptr

#if defined(RELOADINTERNAL) or __FB_DEBUG__
	TYPE HashPtr as ReloadHash ptr
	
	Type StringTableEntry
		str as zstring ptr  'Interned with intern_string()
		'TODO: uses is ignored and never decremented, so old node names
		'are never freed from the string table or hash table, so any
		'node name ever used gets written out in .reload files
		uses as integer
	End Type
	
	TYPE Doc
		version as integer
		root as NodePtr
		strings as StringTableEntry ptr
		numStrings as integer
		numAllocStrings as integer
#if defined(__FB_WIN32__) and not defined(RELOAD_NOPRIVATEHEAP)
		heap as HANDLE
#endif
		stringHash as HashPtr
		delayLoading as bool
		fileHandle as VFile ptr
		fileName as string            'Used for error messages

		'The following members are used only by RELOADBASIC
		RBSignature as integer
		nameIndexTable as short ptr   'pointer to an array
		nameIndexTableLen as integer
		'nameIndexTableBits as uinteger ptr
		RBFuncBits as uinteger ptr
	END TYPE
	
	ENUM NodeFlags
		nfNotLoaded = 1   'Children of this node haven't been loaded. NOTE: numChildren has real value!
		nfProvisional = 2 'When saving, ignore this node if has no children
	END ENUM
	
	TYPE Node
		'name as string
		name as zstring ptr  'Interned with intern_string()
		namenum as short     'Index in the string table
		nodeType as ubyte
		Union 'this saves sizeof(Double) bytes per node!
			num as longint
			flo as double
			str as zstring ptr  'rltString: an allocated string which must be freed
			                    'rltInterdString: an interned string which mustn't be freed
		end Union
		strSize as integer
		numChildren as integer
		children as NodePtr   'aka firstChild
		lastChild as NodePtr
		doc as DocPtr
		parent as NodePtr
		nextSib as NodePtr
		prevSib as NodePtr
		flags as integer
		fileLoc as integer
	END TYPE
#else
	TYPE Doc
		thisIsPrivate as ubyte
	End Type
	TYPE Node
		thisIsPrivate as ubyte
	End Type
#endif


Declare Function CreateDocument() as DocPtr
Declare Function CreateNode overload(byval doc as DocPtr, nam as zstring ptr) as NodePtr
Declare Function CreateNode(byval nod as NodePtr, nam as zstring ptr) as NodePtr
Declare sub FreeChildren(byval nod as NodePtr)
Declare sub FreeNode(byval nod as NodePtr)
Declare sub FreeDocument(byval doc as DocPtr)
Declare sub RenameNode(byval nod as NodePtr, newname as zstring ptr)
Declare sub RemoveProvisionalNodes(byval nod as NodePtr)
Declare sub MarkProvisional(byval nod as NodePtr)
Declare sub SetContent Overload (byval nod as NodePtr, dat as string)
Declare sub SetContent(byval nod as NodePtr, byval zstr as zstring ptr, byval size as integer)
Declare sub SetContent(byval nod as NodePtr, byval dat as longint)
Declare sub SetContent(byval nod as NodePtr, byval dat as double)
Declare sub SetContent(byval nod as NodePtr)
Declare sub SetContentBool(byval nod as NodePtr, byval dat as bool)
Declare sub SetInternedString(byval nod as NodePtr, byval zstr as zstring ptr)
Declare sub AddSiblingBefore(byval sib as NodePtr, byval nod as NodePtr)
Declare sub AddSiblingAfter(byval sib as NodePtr, byval nod as NodePtr)
Declare sub AddChild(byval par as NodePtr, byval nod as NodePtr)
Declare sub SetRootNode(byval doc as DocPtr, byval nod as NodePtr)

Declare Function LoadDocument(fil as string, byval options as LoadOptions = optNone) as DocPtr
Declare Function LoadNode overload(byval ret as nodeptr, byval recursive as bool = YES) as bool

Declare sub SerializeXML overload (byval doc as DocPtr, byval fh as integer, byval debugging as bool = NO, byval shortform as bool = NO)
Declare sub SerializeXML (byval nod as NodePtr, byval fh as integer, byval debugging as bool, byval shortform as bool, byval ind as integer = 0)
Declare sub DumpNodeTree(byval nod as NodePtr)

Declare sub SerializeBin overload (file as string, byval doc as DocPtr)

Declare Function GetString(byval node as nodeptr) as string
Declare Function GetInteger(byval node as nodeptr) as longint
Declare Function GetFloat(byval node as nodeptr) as double
Declare Function GetZString(byval node as nodeptr) as zstring ptr
Declare Function ResizeZString(byval node as nodeptr, byval newsize as integer) as zstring ptr
Declare Function GetZStringSize(byval node as nodeptr) as integer
Declare Function GetInternedString(byval node as NodePtr) as zstring ptr


Declare Function GetChildByName(byval nod as NodePtr, byval nam as zstring ptr) as NodePtr 'NOT recursive
Declare Function FindDescendentByName(byval nod as NodePtr, nam as zstring ptr) as NodePtr 'recursive depth first search
'Other overloads unimplemented
Declare Function GetChildByContent(byval nod as NodePtr, content as longint, name as zstring ptr = null, reverse as bool = NO) as NodePtr

Declare Function DocumentRoot(byval doc as DocPtr) as NodePtr
Declare Function GetDocument(byval nod as NodePtr) as DocPtr
Declare Function NumChildren(byval nod as NodePtr) as integer
Declare Function CountChildren(byval nod as NodePtr, byval withname as zstring ptr) as integer
Declare Function NodeIndex(byval nod as NodePtr) as integer
Declare Function NodeParent(byval nod as NodePtr) as NodePtr
Declare Function FirstChild(byval nod as NodePtr, byval name as zstring ptr = null) as NodePtr
Declare Function NextSibling(byval nod as NodePtr, byval name as zstring ptr = null) as NodePtr
Declare Function PrevSibling(byval nod as NodePtr, byval name as zstring ptr = null) as NodePtr
Declare Function NodeType(byval nod as NodePtr) as NodeTypes
Declare Function NodeName(byval nod as NodePtr) as string
Declare Sub SwapSiblingNodes(byval nod1 as NodePtr, byval nod2 as NodePtr)
Declare Sub SwapNodePrev(byval node as Nodeptr)
Declare Sub SwapNodeNext(byval node as Nodeptr)
Declare Function CloneNodeTree(byval nod as NodePtr, byval doc as DocPtr=0) as NodePtr
Declare Function NodeHasAncestor(byval nod as NodePtr, byval possible_parent as NodePtr) as bool

'Helper functions:
Declare Function GetOrCreateChild Overload (byval parent as NodePtr, n as zstring ptr) as NodePtr
Declare Function SetChildNode Overload (byval parent as NodePtr, n as zstring ptr) as NodePtr
Declare Function SetChildNode(byval parent as NodePtr, n as zstring ptr, byval val as longint) as NodePtr
Declare Function SetChildNode(byval parent as NodePtr, n as zstring ptr, byval val as double) as NodePtr
Declare Function SetChildNode(byval parent as NodePtr, n as zstring ptr, val as string) as NodePtr
Declare Function SetChildNodeBool(byval parent as NodePtr, n as zstring ptr, val as bool) as NodePtr
Declare Function SetChildNodeDate(byval parent as NodePtr, n as zstring ptr, val as double) as NodePtr
Declare Sub ToggleBoolChildNode(byval parent as NodePtr, n as zstring ptr)
Declare Sub ToggleChildNode(byval parent as NodePtr, n as zstring ptr)
Declare Sub FreeChildNode(byval parent as NodePtr, n as zstring ptr)
Declare Function GetChildNodeInt(byval parent as NodePtr, n as zstring ptr, byval d as longint = 0) as longint
Declare Function GetChildNodeFloat(byval parent as NodePtr, n as zstring ptr, byval d as double = 0.0) as Double
Declare Function GetChildNodeStr(byval parent as NodePtr, n as zstring ptr, d as string = "") as string
Declare Function GetChildNodeBool(byval parent as NodePtr, n as zstring ptr, byval d as integer = 0) as bool
Declare Function GetChildNodeExists(byval parent as NodePtr, n as zstring ptr) as bool
Declare Function AppendChildNode Overload (byval parent as NodePtr, n as zstring ptr) as NodePtr
Declare Function AppendChildNode(byval parent as NodePtr, n as zstring ptr, byval val as longint) as NodePtr
Declare Function AppendChildNode(byval parent as NodePtr, n as zstring ptr, byval val as double) as NodePtr
Declare Function AppendChildNode(byval parent as NodePtr, n as zstring ptr, val as string) as NodePtr
Declare Function ChildByIndex(byval parent as NodePtr, byval index as integer, byval withname as zstring ptr = NULL) as NodePtr

Declare function ReadVLI overload(byval f as integer) as longint
Declare Sub WriteVLI overload(byval f as integer, byval v as longint)
Declare Function ReadVLI(byval vf as VFile ptr) as longint
Declare Sub WriteVLI(byval f as BufferedFile ptr, byval v as longint)

Declare Function DocumentMemoryUsage(byval doc as DocPtr) as longint

#if defined(RELOADINTERNAL) or __FB_DEBUG__
	'ReloadBasic stuff

	Type RBNodeName
		nameindex as integer
		name as zstring ptr
	End Type

	Declare Sub BuildNameIndexTable(byval doc as DocPtr, nodenames() as RBNodeName, byval func_num as integer, byval func_bits_size as integer, byval signature as integer, byval total_num_names as integer)
	Declare Function GetChildByNameIndex(byval nod as NodePtr, byval nameindex as integer) as NodePtr
#endif


End Namespace

#endif