/*
 *
 * @APPLE_LICENSE_HEADER_START@
 *
 * Copyright (c) 1999-2001 Apple Computer, Inc.  All Rights Reserved. The
 * contents of this file constitute Original Code as defined in and are
 * subject to the Apple Public Source License Version 1.2 (the 'License').
 * You may not use this file except in compliance with the License.  Please
 * obtain a copy of the License at http://www.apple.com/publicsource and
 * read it before using this file.
 *
 * This Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.  Please
 * see the License for the specific language governing rights and
 * limitations under the License.
 *
 *
 * @APPLE_LICENSE_HEADER_END@
 *
 */

#ifndef __XMLParser_h__
#define __XMLParser_h__

#include "StringParser.h"
#include "OSQueue.h"
#include "OSFileSource.h"
#include "ResizeableStringFormatter.h"

class DTDVerifier
{
public:
	virtual bool IsValidSubtag(char* tagName, char* subTagName) = 0;
	virtual bool IsValidAttributeName(char* tagName, char* attrName) = 0;
	virtual bool IsValidAttributeValue(char* tagName, char* attrName, char* attrValue) = 0;
	virtual char* GetRequiredAttribute(char* tagName, int index) = 0;
	virtual bool CanHaveValue(char* tagName) = 0;
};

class XMLTag
{
public:
	XMLTag();
	XMLTag(const char* tagName);
	~XMLTag();
	
	bool ParseTag(StringParser* parser, DTDVerifier* verifier, char* errorBuffer = NULL, int errorBufferSize = 0);
	
	char* GetAttributeValue(const char* attrName);
	char* GetValue() { return fValue; }
	char* GetTagName() { return fTag; }
	
	UInt32 GetNumEmbeddedTags() { return fEmbeddedTags.GetLength(); }
	
	XMLTag* GetEmbeddedTag(const UInt32 index = 0);
	XMLTag* GetEmbeddedTagByName(const char* tagName, const UInt32 index = 0);
	XMLTag* GetEmbeddedTagByAttr(const char* attrName, const char* attrValue, const UInt32 index = 0);
	XMLTag* GetEmbeddedTagByNameAndAttr(const char* tagName, const char* attrName, const char* attrValue, const UInt32 index = 0);
	
	void AddAttribute(const char* attrName, const char* attrValue);
	void RemoveAttribute(const char* attrName);
	void AddEmbeddedTag(XMLTag* tag);
	void RemoveEmbeddedTag(XMLTag* tag);
	
	void SetTagName(const char* name);
	void SetValue(const char* value);
	
	void FormatData(ResizeableStringFormatter* formatter, UInt32 indent);

private:
	void ConsumeIfComment(StringParser* parser);

	char* fTag;
	char* fValue;
	OSQueue fAttributes;
	OSQueue fEmbeddedTags;
	
	OSQueueElem fElem;

	static UInt8 sNonNameMask[]; 		// stop when you hit a word
};

class XMLAttribute
{
public:
	XMLAttribute();
	~XMLAttribute();
	
	char* fAttrName;
	char* fAttrValue;
	
	OSQueueElem fElem;
};

class XMLParser
{
public:
	XMLParser(const char* inPath, DTDVerifier* verifier = NULL);
	~XMLParser();
	
	// Check for existence, man.
	Bool16	DoesFileExist();
	Bool16	DoesFileExistAsDirectory();
	Bool16	CanWriteFile();
	
	Bool16	ParseFile(char* errorBuffer = NULL, int errorBufferSize = 0);
		
	XMLTag* GetRootTag() { return fRootTag; }
	void SetRootTag(XMLTag* tag);
	
	void WriteToFile(char** fileHeader);
	
private:
	XMLTag*			fRootTag;
		
	OSFileSource 	fFile;
	char*			fFilePath;
	DTDVerifier*	fVerifier;
};

#endif