// JAErrorTree_OC_IOS_Undocumented_Header.txt
// JAErrorTree
//
// This file is published under the Creative Commons Attribution 3.0 License.
// www.JasonAndrade.ca
//
// This is the undocumented version of the JAErrorTree_OC_IOS.h header file.
// The purpose of this file is to convey the API of the JAErrorTree library written in Objective-C for the IOS platform.
// While this version of the file has been published under the Creative Commons Attribution 3.0 License, the documented version included with the commercial software library is protected by copyright law.
// The documented version of this file contains detailed descriptions of every method/function and how they are to be correctly utilized.


#include <mach/mach.h>
#include <mach/mach_time.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>


#import <Foundation/Foundation.h>


typedef enum
{
	JAErrorTreeTypeWarning,
	JAErrorTreeTypeError
} JAErrorTreeType;


@interface JAErrorTree:NSObject
{
@private
	short _filenameLen;
	char *_filenamePtr;
	JAErrorTree *_firstChildNodeObjectPtr;
	int _lineNumber;
	short _messageLen;
	char *_messagePtr;
	JAErrorTree *_nextSiblingNodeObjectPtr;
	JAErrorTree *_parentNodeObjectPtr;
	JAErrorTree *_previousSiblingNodeObjectPtr;
	uint64_t _time;
	JAErrorTreeType _type;
}


+(JAErrorTree *) newJAErrorTreeNode:(JAErrorTree **)newJAErrorTreeNodeObjectPtrAddr type:(const JAErrorTreeType)newType filename:(const char *)newFilenamePtr filenameLen:(const short)newFilenameLen lineNumber:(const int)newLineNumber message:(const char *)newMessagePtr messageLen:(const short)newMessageLen;
+(bool) validateJAErrorTree:(JAErrorTree *)aJAErrorTreeObjectPtr;
+(bool) tripleCheckAndCorrectFirstJAErrorTree:(JAErrorTree **)firstJAErrorTreeObjectPtrAddr firstJAErrorTreeWasValid:(bool *)firstJAErrorTreeWasValidPtr secondJAErrorTree:(JAErrorTree **)secondJAErrorTreeObjectPtrAddr secondJAErrorTreeWasValid:(bool *)secondJAErrorTreeWasValidPtr thirdJAErrorTree:(JAErrorTree **)thirdJAErrorTreeObjectPtrAddr thirdJAErrorTreeWasValid:(bool *)thirdJAErrorTreeWasValidPtr;


-(void) addChildNode:(JAErrorTree *)newChildNodeObjectPtr;
-(bool) compareEqualJAErrorTree:(JAErrorTree *)operandObjectPtr;
-(char *) getFilename;
-(short) getFilenameLen;
-(JAErrorTree *) getFirstChildNode;
-(int) getLineNumber;
-(char *) getMessage;
-(short) getMessageLen;
-(JAErrorTree *) getNextSiblingNode;
-(JAErrorTree *) getParentNode;
-(JAErrorTree *) getPreviousSiblingNode;
-(uint64_t) getTime;
-(JAErrorTreeType) getType;
-(const char *) getTypeAsString;
-(bool) hasChildren;
-(JAErrorTree *) newCopy;
-(void) printWithScopeLevel:(const int)currentScopeLevel;

@end