//
// Cforall Version 1.0.0 Copyright (C) 2015 University of Waterloo
//
// The contents of this file are covered under the licence agreement in the
// file "LICENCE" distributed with Cforall.
//
// LinkageSpec.h --
//
// Author           : Rodolfo G. Esteves
// Created On       : Sat May 16 13:24:28 2015
// Last Modified By : Peter A. Buhr
// Last Modified On : Sat Jul 22 09:32:16 2017
// Update Count     : 14
//

#pragma once

#include <string>

#include "Common/CodeLocation.h"

namespace LinkageSpec {
	// All linkage specs are some combination of these flags:
	enum {
		Mangle = 1 << 0,
		Generate = 1 << 1,
		Overrideable = 1 << 2,
		Builtin = 1 << 3,

		NoOfSpecs = 1 << 4,
	};

	union Spec {
		unsigned int val;
		struct {
			bool is_mangled : 1;
			bool is_generatable : 1;
			bool is_overridable : 1;
			bool is_builtin : 1;
		};
		constexpr Spec( unsigned int val ) : val( val ) {}
		constexpr Spec( Spec const &other ) : val( other.val ) {}
		// Operators may go here.
		// Supports == and !=
		constexpr operator unsigned int () const { return val; }
	};


	Spec linkageCheck( CodeLocation location, const std::string * );
	// Returns the Spec with the given name (limited to C, Cforall & BuiltinC)
	Spec linkageUpdate( CodeLocation location, Spec old_spec, const std::string * cmd );
	/* If cmd = "C" returns a Spec that is old_spec with is_mangled = false
	 * If cmd = "Cforall" returns old_spec Spec with is_mangled = true
	 */

	std::string linkageName( Spec );

	// To Update: LinkageSpec::isXyz( cur_spec ) -> cur_spec.is_xyz
	inline bool isMangled( Spec spec ) { return spec.is_mangled; }
	inline bool isGeneratable( Spec spec ) { return spec.is_generatable; }
	inline bool isOverridable( Spec spec ) { return spec.is_overridable; }
	inline bool isBuiltin( Spec spec ) { return spec.is_builtin; }

	// Pre-defined flag combinations:
	// C built-in defined in prelude
	constexpr Spec const Intrinsic = { Mangle | Generate | Overrideable | Builtin };
	// ordinary
	constexpr Spec const Cforall = { Mangle | Generate };
	// not overloadable, not mangled
	constexpr Spec const C = { Generate };
	// built by translator (struct assignment)
	constexpr Spec const AutoGen = { Mangle | Generate | Overrideable };
	// gcc internal
	constexpr Spec const Compiler = { Builtin };
	// mangled builtins
	constexpr Spec const BuiltinCFA = { Mangle | Generate | Builtin };
	// non-mangled builtins
	constexpr Spec const BuiltinC = { Generate | Builtin };
};

// Local Variables: //
// tab-width: 4 //
// mode: c++ //
// compile-command: "make install" //
// End: //