/* $Id$
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.etch.compiler.ast;

import java.util.Map;

import org.apache.etch.compiler.Backend;
import org.apache.etch.compiler.ParseException;


/**
 * An extern declaration from the etch idl.
 */
public class Extern extends ParamList<Service>
{
	/**
	 * @param intf
	 * @param name
	 * @param opts
	 */
	public Extern( Service intf, Name name, Map<String, Opt> opts )
	{
		super( intf, name, opts );

		vname = intf.parent().name().name.replace( '.', '_' )+'_'+intf.name()+'_'+name;
		fqname = intf.parent().name().name+'.'+intf.name().name+'.'+name.name;
	}
	
	private final String vname;
	
	private final String fqname;

	@Override
	public Service service()
	{
		return parent();
	}

	@Override
	public void check() throws ParseException
	{
		checkTypeName( name() );
		
		// nothing to do
	}

	@Override
	public void dump( String indent )
	{
		System.out.printf( "%sextern %s\n", indent, name() );
	}

	@Override
	public String fqname()
	{
		return fqname;
	}

	@Override
	public String efqname( Backend helper )
	{
		String lang = helper.getLang();
		org.apache.etch.compiler.opt.Extern opt = (org.apache.etch.compiler.opt.Extern) getOpt( "Extern."+lang );
		if (opt == null)
			return null;
		return opt.xname.image;
	}

	@Override
	public String vname( Backend helper )
	{
		return helper.mtvname( vname );
	}
	
	/**
	 * @param helper
	 * @return the extern's serializer's name.
	 */
	public String sname( Backend helper )
	{
		String lang = helper.getLang();
		org.apache.etch.compiler.opt.Extern opt = (org.apache.etch.compiler.opt.Extern) getOpt( "Extern."+lang );
		if (opt == null)
			// TODO need to throw the right thing...
			throw new UnsupportedOperationException( String.format(
				"no extern type defined for binding %s: %s at line %d",
				lang, name().name, name().token.beginLine ) );
		return opt.serializer.image;
	}
	
	/**
	 * @param helper
	 * @return true if the extern needs an import.
	 */
	public boolean hasImport( Backend helper )
	{
		String lang = helper.getLang();
		org.apache.etch.compiler.opt.Extern opt = (org.apache.etch.compiler.opt.Extern) getOpt( "Extern."+lang );
		if (opt == null)
			return false;
		return opt.xnameImport.image.length() > 0;
	}
	
	/**
	 * @param helper
	 * @return the extern's import.
	 */
	public String getImport( Backend helper )
	{
		String lang = helper.getLang();
		org.apache.etch.compiler.opt.Extern opt = (org.apache.etch.compiler.opt.Extern) getOpt( "Extern."+lang );
		if (opt == null)
			return null;
		return opt.xnameImport.image;
	}

	/**
	 * @param helper
	 * @return true if the extern's serializer needs an import.
	 */
	public boolean hasSerializerImport( Backend helper )
	{
		String lang = helper.getLang();
		org.apache.etch.compiler.opt.Extern opt = (org.apache.etch.compiler.opt.Extern) getOpt( "Extern."+lang );
		if (opt == null)
			return false;
		return opt.serializerImport.image.length() > 0;
	}

	/**
	 * @param helper
	 * @return the extern's serializer's import.
	 */
	public String getSerializerImport( Backend helper )
	{
		String lang = helper.getLang();
		org.apache.etch.compiler.opt.Extern opt = (org.apache.etch.compiler.opt.Extern) getOpt( "Extern."+lang );
		if (opt == null)
			return null;
		return opt.serializerImport.image;
	}

	@Override
	public void treewalk( TreeWalker walker ) throws ParseException
	{
		walker.doExtern( this );
	}
}