/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is [Open Source Virtual Machine.].
 *
 * The Initial Developer of the Original Code is
 * Adobe System Incorporated.
 * Portions created by the Initial Developer are Copyright (C) 2004-2006
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Adobe AS3 Team
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#ifndef __avmplus_PoolObject__
#define __avmplus_PoolObject__


namespace avmplus
{
	/**
	 * The PoolObject class is a container for the pool of resources
	 * decoded from an ABC file: the constant pool, the methods
	 * defined in the ABC, the classes defined in the ABC, and so on.
	 */
	class PoolObject : public MMgc::GCFinalizedObject
	{
	public:
		AvmCore *core;

		/** constants */
		List<int, LIST_NonGCObjects> cpool_int;
		List<uint32, LIST_NonGCObjects> cpool_uint;
		List<double*, LIST_GCObjects> cpool_double;
		List<Stringp, LIST_RCObjects> cpool_string;
		List<Namespace*, LIST_RCObjects> cpool_ns;
		List<NamespaceSet*, LIST_GCObjects> cpool_ns_set;

		// LIST_NonGCObjects b/c these aren't really atoms, they are offsets
		List<Atom,LIST_NonGCObjects> cpool_mn;

		/** all methods */
		List<AbstractFunction*, LIST_GCObjects> methods;

		/** metadata */
		List<const byte*,LIST_NonGCObjects> metadata_infos;

		/** domain */
		DWB(Domain*) domain;
		
		/** constructors for class objects, for op_newclass */
		List<AbstractFunction*, LIST_GCObjects> cinits;  // TODO just use methods array, dont need new cinits array
		List<AbstractFunction*, LIST_GCObjects> scripts;

		/** # of elements in methods array */
		uint32 methodCount;

		/** # of elements in metadata array */
		uint32 metadataCount;

		/** # of elements in cpool array */
		uint32 constantCount;
		uint32 constantIntCount;
		uint32 constantUIntCount;
		uint32 constantDoubleCount;
		uint32 constantStringCount;
		uint32 constantNsCount;
		uint32 constantNsSetCount;
		uint32 constantMnCount;

		/** # of elements in classes array */
		uint32 classCount;

		/** # of elements in scripts array */
		uint32 scriptCount;

		// true if this pool is baked into the player.  used to control
		// whether callees will set their context.
		bool isBuiltin;

		#ifdef AVMPLUS_MIR
		/** buffer containing generated machine code for all methods */
		GrowableBuffer *codeBuffer;
		sintptr stackOverflowHandler; // address of stack overflow handler
		#endif /*AVMPLUS_MIR */

		PoolObject(AvmCore* core, ScriptBuffer& sb, const byte* startpos);
		~PoolObject();

		AbstractFunction* getMethodInfo(uint32 index);

		AbstractFunction* getNamedScript(Multiname* multiname) const;

		const byte* getMetadataInfoPos(uint32 index);
		Traits* getTraits(Stringp name, Namespace* ns, bool recursive=true) const;
		Traits* getTraits(Multiname* n, const Toplevel* toplevel, bool recursive=true) const;
		Traits* getTraits(Stringp name, bool recursive=true) const;

		Traits* getBuiltinTraits(Stringp name) const;

		void addPrivateNamedScript(Stringp name, Namespace* ns, AbstractFunction *a);
		void addNamedTraits(Stringp name, Namespace* ns, Traits* traits);
		
		//
		// deferred parsing
		//

		void parseMultiname(const byte *pos, Multiname& m) const;
		void resolveTraits(Traits *traits, int firstSlot, const Toplevel* toplevel);
		Traits* resolveTypeName(const byte* &pc, const Toplevel* toplevel, bool allowVoid=false) const;
		Atom resolveQName(const byte* &p, Multiname &m, const Toplevel* toplevel) const;



		/**
		* we allow early binding to a type if it is defined in 
		* the same abc file as the reference, or if the type is
		* specially marked to allow early binding by making it's
		* Traits->pool pointer be null.  We only do this for Object
		*/
		void allowEarlyBinding(Traits* t, bool& slot) const;

		void parseMultiname(Multiname& m, int index) const
		{
			AvmAssert (index >= 0 && index < int(constantMnCount));
			Atom a = cpool_mn[index];
			parseMultiname(atomToPos(a), m);
		}

		void parseMultiname(Atom a, Multiname& m) const
		{
			parseMultiname(atomToPos(a), m);
		}

		Namespace* getNamespace(int index) const;
		NamespaceSet* getNamespaceSet(int index) const;
		Stringp getString(int index) const;

		Atom getDefaultValue(const Toplevel* toplevel, uint32 index, CPoolKind kind, Traits* t) const;

		Atom posToAtom(const byte* pos) const
		{
			return (pos - abcStart)<<3 | kObjectType;
		}

		const byte* atomToPos(Atom a) const
		{
			AvmAssert((a&7)==kObjectType);
			return abcStart + urshift(a,3);
		}


#ifdef AVMPLUS_VERIFYALL
		List<AbstractFunction*, LIST_GCObjects> verifyQueue;
		void enq(AbstractFunction* f);
		void enq(Traits* t);
		void processVerifyQueue(Toplevel* toplevel);
#endif
		#ifdef AVMPLUS_VERBOSE
		bool verbose;
		#endif

		int version;
		
		ScriptBuffer code() 
		{ 
			return (ScriptBufferImpl*)m_code; 
		}

		bool isCodePointer(const byte* pos)
		{
			return pos > &code()[0] && pos < m_code->getBuffer() + code().getSize();
		}

	private:
		DWB(MultinameHashtable*) namedTraits;
		MultinameHashtable privateNamedScripts;
		DWB(ScriptBufferImpl*) m_code;
		const byte * const abcStart;
	};
}

#endif /* __avmplus_PoolObject__ */